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.

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

Add usage examples to ami commands usage help message #30

Open
remkop opened this issue Apr 18, 2020 · 2 comments
Open

Add usage examples to ami commands usage help message #30

remkop opened this issue Apr 18, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@remkop
Copy link
Collaborator

remkop commented Apr 18, 2020

Follow-up item coming out of discussion on #15 :

Examples

There are not enough examples in the subcommands. In the @Command section of each class we should have some examples. These should be runnable by copy paste so newcomers can run them to help understand how they work.

@remkop remkop added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 19, 2020
@petermr
Copy link
Owner

petermr commented Apr 19, 2020 via email

@remkop
Copy link
Collaborator Author

remkop commented Apr 19, 2020

I usually put examples in the @Command footer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants