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

Provide screenshots showing error messages in docs #5

Open
xenomachina opened this issue Feb 1, 2017 · 1 comment
Open

Provide screenshots showing error messages in docs #5

xenomachina opened this issue Feb 1, 2017 · 1 comment
Labels
enhancement

Comments

@xenomachina
Copy link
Owner

As suggested by @mikehearn:

It'd be great if you could provide some screenshots showing what a program that uses argparse looks like to the user, both help text and errors when the args are wrong.
@xenomachina
Copy link
Owner Author

I've added an example of help text to the README. (not a screenshot, but this is text so I assume a preformatted block is just as good)

I'll consider adding error messages too, so leaving this open for now.

@xenomachina xenomachina changed the title Provide screenshots showing help text and error messages in docs Provide screenshots showing error messages in docs Apr 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@xenomachina