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

Move the documentation to the help function #3

Open
amtoine opened this issue Jun 11, 2022 · 0 comments
Open

Move the documentation to the help function #3

amtoine opened this issue Jun 11, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@amtoine
Copy link
Owner

amtoine commented Jun 11, 2022

Right now, a great part of the documentation of each script is located in its header. This is not very useful as the user mainly has access to the --help switch.

This issue proposes to move all the documentation to the help function, activated by the --help switch.
@amtoine amtoine added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 11, 2022
@amtoine amtoine self-assigned this Jun 11, 2022
@amtoine amtoine removed their assignment Nov 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@amtoine