art-framework-suite / art

The implementation of the art physics event processing framework
Other
2 stars 7 forks source link

Request improvements to art documentation #123

Open kutschke opened 2 years ago

kutschke commented 2 years ago

Describe your request or issue Request improvements to the documentation for renaming RootOutput and TFileService output files. See below for details.

If this is a high-priority issue No.

Details

There are two requests.

First, about https://cdcvs.fnal.gov/redmine/projects/art/wiki/Output_file_renaming_for_ROOT_files The description of the "%s" format descriptor is: "Lowest subrun # of subrun records written to this file1." I think that a more accurate description is something like: "the subrun field of the lowest SubrunID for which there is a SubRun record in the file". The distinction is the following. Suppose the a file contains run:subrun 1:20 and 2:10; the text, as written, says that the value will be 10. In fact the value is 20, which is the behaviour that Mu2e needs. I presume that a similar clarification is needed for the %S format descriptor.

You may also wish to remind people that, in a sparse skim, the subrun records are present even if all events from that subrun have been filtered out.

Second. I believe that RootOutput supports all of the format descriptors described for the TFileService. Is that correct? I could not find anything in the redmine wiki documentation that discusses the full set of features for renaming output files. One possibility might be to make a common page and refer to it from both places. Please consider adding the url of this page in the printout from --print-description on RootOutput and TFileService.

knoepfel commented 2 years ago

Thanks, @kutschke, for the suggestions. We will adjust the documentation.