numere-org / NumeRe

Framework for numerical computations, data analysis and visualisation
https://www.numere.org
GNU General Public License v3.0
18 stars 6 forks source link

Documentation and interface of 'hist/hist2d' #27

Closed numeredev closed 1 year ago

numeredev commented 1 year ago

DESCRIPTION

Is your change request related to a problem? Please describe. The interface and the documentation is incomplete. It would be be better, if the documenation would be more complete and that the interface is more streamlined than it currently is.

Describe the solution you'd like Improve the documentation and the interface of hist and hist2d

Describe possible alternatives you've considered None

Additional context Add any other context or screenshots about the feature request here.

(Do not write below this line)


DEVS' SECTION

ANALYSIS

The function void plugin_histogram(std::string& sCmd) should accept a CommandLineParser instance instead of the pure pre-evaluated string. This makes adding parameters and features much easier.

The documentation article should probably be more or less completely rewritten. The language strings should not indicated the documentation articles explicitly, as this is done mostly nowhere.

IMPLEMENTATION STEPS

(see also our Wiki for implementation guidelines)

DOCUMENTATION STEPS

(see also our Wiki for further information)

PULL REQUEST