pace-neutrons / Horace

Horace is a suite of programs for the visualization and analysis of large datasets from time-of-flight neutron inelastic scattering spectrometers.
https://pace-neutrons.github.io/Horace/stable/
GNU General Public License v3.0
7 stars 4 forks source link

suggested solution on dash/undash consistency #1685

Open abuts opened 2 months ago

abuts commented 2 months ago

Horace algorithms may be controlled by keys which are keywords having true or false value and parameters which are keywords which may have arbitrary values.

There is agreement that Horace should use dashes for algorithm's keys and no dashes for algorithm's parameters.

Unfortunately, current situation in Horace is complete mess. Some parameters have to be called with dashes and some can not be. Some keys have to be issues with dashes and other -- only without them.

It not entirely clear how to change this as the change would break user scripts in multiple unexpected places.

The suggested soulution is to change Horace to accept keys and parameters with or without dashes, where correct combination (parameters -- no dashes, keys -- mandatory dashes will be default and the opposite situation -- undocumented.

Then on later stage, undocumented combination would start issuing warning, and finally, will be removed.