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

Documentation Improvements #7

Open
knoepfel opened this issue Oct 28, 2021 · 1 comment
Open

Documentation Improvements #7

knoepfel opened this issue Oct 28, 2021 · 1 comment
Labels
maintenance Maintenance issue to address

Comments

@knoepfel
Copy link
Contributor

This issue has been migrated from https://cdcvs.fnal.gov/redmine/issues/25408 (FNAL account required)
Originally created by @aihimmel on 2021-01-15 21:25:41


Since I ran into some issues in the documentation, I wanted to write them down somewhere before I forgot so they can be fixed for the next person.

This is the page I usually find when googling "fhicl configuration validation,"

https://cdcvs.fnal.gov/redmine/projects/fhicl-cpp/wiki/Configuration_validation_and_fhiclcpp_types

so I'd recommend mentioning the existence of DelegatedParameters and the like on this page, and linking to this page:

https://cdcvs.fnal.gov/redmine/projects/fhicl-cpp/wiki/Auxiliary_classes

On that second page, it would help a lot to list the required includes in the examples for each of the different classes.

@knoepfel knoepfel added the maintenance Maintenance issue to address label Oct 28, 2021
@knoepfel
Copy link
Contributor Author

Comment by @knoepfel on 2021-02-17 16:32:02


See TOC [[Configuration_validation_and_fhiclcpp_types#section-2 | here]].

@knoepfel knoepfel added this to Issues Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance issue to address
Projects
Status: No status
Development

No branches or pull requests

1 participant