Update top level docs and docs of methods that configure into Options #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rewrite the usage introduction to mention only builder-like methods that add option config when creating instance of Options struct. Passing vector of components is not supported now and the working may cause confusion. Add mention of the double-dash '--' argument and how it works to the overview of option handling
Provide example usage for methods that configure accepted options. The examples describe how to do basic setup and how to query parsed Matches instance for builder-like methods. The only exception is the opt() method which provides too much freedom of configuration to write short sensible example.
|
Thanks @zdenek-crha! This looks good to me. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The pull request contains two changes (in separate commits) for ticket #44 :
Update wording of top level documentation to talk only about methods that add configuration options since creating components by hand is not supported in current code.
Add examples for methods that add configuration options (except
opt())For the second change I have considered enhancing the top level example, but felt that it would become bloated and hard to read. Instead I've opted into adding short, basic setup & query examples to each method that adds option into parser configuration instance.
I have also submitted ticket #102 as side result of the implementation - using
std::matchesmacro could make examples that showcaseFailenum shorter and easier to read. But I did not want to break backward compatibility (because I did not know what it is :-))Feel free to review and critique.