haddock-tools icon indicating copy to clipboard operation
haddock-tools copied to clipboard

Descriptive Headers

Open JoaoRodrigues opened this issue 10 years ago • 1 comments

More of a recommendation than a real 'issue'. Each script should have its own description and usage written at the top of the file, and print this if ran without arguments or with -h or so. This avoids a lengthy list of usage/descriptions in the front page and makes the scripts much more user-friendly.

JoaoRodrigues avatar Sep 16 '15 12:09 JoaoRodrigues

True, but some in the CSB version are a directory with multiple scripts…

For the public version we should for sure aim at that.

amjjbonvin avatar Sep 16 '15 12:09 amjjbonvin