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

Docs: show all options in help and README #84

Merged
merged 1 commit into from
Feb 17, 2022
Merged

Docs: show all options in help and README #84

merged 1 commit into from
Feb 17, 2022

Conversation

jrfnl
Copy link
Collaborator

@jrfnl jrfnl commented Feb 17, 2022

This commit syncs the three lists of the supported options:

  • The processing of received arguments in the Application class.
  • The CLI help in the Settings class.
  • The options shown in the README.

I have verified that:

  • The options in all three lists are now in the same order to make future maintenance more straight-forward.
    Includes having all functional short options at the top of the lists.
  • All options are now shown in the help and the README.
  • The descriptions in the help and in the README are complete and largely the same (minus the "further reading" links shown in the README).

Includes:

  • Fixing a typo in the help -asp vs --asp.
  • Line length management for the CLI help.
  • Minor grammatical improvement.

Fixes #81

@jrfnl
Docs: show all options in help and README
d7b3fac 
This commit syncs the three lists of the supported options:
* The processing of received arguments in the `Application` class.
* The CLI help in the `Settings` class.
* The options shown in the README.

I have verified that:
* The options in all three lists are now in the same order to make future maintenance more straight-forward.
    Includes having all functional short options at the top of the lists.
* All options are now shown in the help and the README.
* The descriptions in the help and in the README are complete and largely the same (minus the "further reading" links shown in the README).

Includes:
* Fixing a typo in the help `-asp` vs `--asp`.
* Line length management for the CLI help.
* Minor grammatical improvement.

Fixes 81
@jrfnl jrfnl added this to the 1.x Next milestone Feb 17, 2022
@jrfnl jrfnl requested a review from grogy February 17, 2022 01:42
@jrfnl jrfnl mentioned this pull request Feb 17, 2022
Closed
@grogy
Copy link
Member

grogy commented Feb 17, 2022

Perfect, thank you 👍

@grogy grogy merged commit 8199c49 into master Feb 17, 2022
@grogy grogy deleted the feature/81-update-help-readme-to-show-all-options branch February 17, 2022 04:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grogy grogy Awaiting requested review from grogy

Assignees
No one assigned
Labels
Type: documentation
Milestone
1.3.2
Development

Successfully merging this pull request may close these issues.

Suggestion to add the --show-deprecated option to help/docs
2 participants
@jrfnl @grogy