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

Improve (shorten) user manual #112

Closed
10 tasks done
remkop opened this issue Apr 30, 2017 · 0 comments
Closed
10 tasks done

Improve (shorten) user manual #112

remkop opened this issue Apr 30, 2017 · 0 comments
Labels
type: doc 📘 type: enhancement ✨
Milestone
0.9.4

Comments

@remkop
Copy link
Owner

remkop commented Apr 30, 2017 •
edited
Loading

  • replace ascii art explaining options vs parameters with image
  • combine Arity and Multiple Values section
  • use fewer words
  • subsections: Default, Arity, Split Regex, Multiple Occurrences
  • create "Tips & Tricks" section near the bottom, which includes:
    • Boolean fields requiring a parameter
    • Type Converters for hexadecimal numerical values
    • subclassing for reuse
  • reorder help sections
  • reorder ANSI colors sections
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: doc 📘 type: enhancement ✨
Projects
None yet
Milestone
0.9.4
Development

No branches or pull requests
1 participant
@remkop