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

Include example invocations in the help text #10

Open
ericcornelissen opened this issue Apr 27, 2023 · 0 comments
Open

Include example invocations in the help text #10

ericcornelissen opened this issue Apr 27, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ericcornelissen
Copy link
Owner

Feature Request

Summary

Per the Command Line Interface Guidelines' section on help text providing example invocations can help users get started with a CLI program. Even if rm is quite straightforward and common, new users may still benefit from an example. Especially given the distinction between short the help message with -h and long help message with --help, adding an example really shouldn't hurt anyone.
@ericcornelissen ericcornelissen added the documentation Improvements or additions to documentation label Apr 27, 2023
@ericcornelissen ericcornelissen changed the title Include an example Include example invocations in the help text Apr 27, 2023
@ericcornelissen ericcornelissen added the enhancement New feature or request label Apr 27, 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
@ericcornelissen