Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Descriptive Headers #3

Open
JoaoRodrigues opened this issue Sep 16, 2015 · 1 comment
Open

Descriptive Headers #3

JoaoRodrigues opened this issue Sep 16, 2015 · 1 comment

Comments

@JoaoRodrigues
Copy link
Member

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.
@amjjbonvin
Copy link
Member

amjjbonvin commented Sep 16, 2015 •
edited by JoaoRodrigues
Loading

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JoaoRodrigues @amjjbonvin