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

.usage is not documented #902

Closed
toymachiner62 opened this issue Jan 3, 2019 · 5 comments
Closed

.usage is not documented #902

toymachiner62 opened this issue Jan 3, 2019 · 5 comments
Labels
docs README (or other docs) could be improved

Comments

@toymachiner62
Copy link

I see this example of .usage, but it's not documented anywhere on the README file.

This should be documented in the README so we know how to use it.

image
@tahayk
Copy link

tahayk commented Jan 11, 2019

+1

@baruchvlz
Copy link

If you read the code here, seems pretty straight forward to me. It logs the commands and flag options you have added through .option....

@toymachiner62
Copy link
Author

toymachiner62 commented Jan 19, 2019 •
edited
Loading

@baruchvlz That's great that you were able to dig through the code and find it's usage. That doesn't mean that it shouldn't be documented.

@shadowspawn shadowspawn added the docs README (or other docs) could be improved label Mar 27, 2019
@shadowspawn
Copy link
Collaborator

(Note to self: unrelated other than also undocumented and might cover in same section of less common routines, .name() and .opts().)

@shadowspawn shadowspawn mentioned this issue Aug 10, 2019
Merged
@shadowspawn
Copy link
Collaborator

Added .name and .usage to README in v3.0.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs README (or other docs) could be improved
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@toymachiner62 @baruchvlz @shadowspawn @tahayk