Project

General

Profile

Feature #17407

Description of parameter set

Added by Gianluca Petrillo about 2 years ago. Updated over 1 year ago.

Status:
Accepted
Priority:
Normal
Assignee:
-
Category:
Infrastructure
Target version:
Start date:
08/08/2017
Due date:
% Done:

0%

Estimated time:
24.00 h
Scope:
Internal
Experiment:
LArSoft
SSI Package:
fhicl-cpp
Duration:

Description

fhiclcpp offers automated validation and documentation of the configuration parameters.
It would be good to have the same documentation possibility for the top level configuration object.
For example:

struct Config {

  fhicl::Description desc{
    "The module estimates the momentum of the specified tracks from their Coulomb scattering." 
    };

  fhicl::Atom<art::InputTag> tracks{
    fhicl::Name{"tracks"},
    fhicl::Comment{"tag of collection of tracks to be analysed"}
  };

}; // struct Config

The idea is that when Config is enclosed in a fhicl::Table and its description is requested, the content of the object(s) of type fhicl::Description is dumped as header of the parameter documentation.

History

#1 Updated by Kyle Knoepfel about 2 years ago

  • Status changed from New to Accepted
  • Estimated time set to 24.00 h

This is a sensible request. It is somewhat non-trivial, however, to come up with an implementation that interacts seamlessly with the current system.

#2 Updated by Kyle Knoepfel over 1 year ago

  • Target version set to Vega


Also available in: Atom PDF