Project

General

Profile

Necessary Maintenance #25408

Documentation Improvements

Added by Alexander Himmel about 2 months ago. Updated 13 days ago.

Status:
Resolved
Priority:
Low
Assignee:
-
Target version:
-
Start date:
01/15/2021
Due date:
% Done:

100%

Estimated time:
Duration:

Description

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.

History

#1 Updated by Kyle Knoepfel about 2 months ago

  • Status changed from New to Accepted

#2 Updated by Kyle Knoepfel 13 days ago

  • % Done changed from 0 to 100
  • Status changed from Accepted to Resolved
  • Tracker changed from Idea to Necessary Maintenance

See TOC here.

Also available in: Atom PDF