Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request improvements to art documentation #123

Open
kutschke opened this issue Feb 2, 2022 · 1 comment
Open

Request improvements to art documentation #123

kutschke opened this issue Feb 2, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@kutschke
Copy link

kutschke commented Feb 2, 2022

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 knoepfel added this to Issues Feb 7, 2022
@knoepfel knoepfel moved this to Todo in Issues Feb 7, 2022
@knoepfel
Copy link
Contributor

knoepfel commented Feb 7, 2022

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

@knoepfel knoepfel added the documentation Improvements or additions to documentation label Feb 16, 2022
@knoepfel knoepfel moved this from Todo to In Progress in Issues Feb 16, 2022
@knoepfel knoepfel self-assigned this Feb 16, 2022
@knoepfel knoepfel added this to the art 3.11.00 milestone Feb 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

No branches or pull requests

2 participants