-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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.
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
Rework options description to clarify option types and custom processing #953
Conversation
I have added about 100 lines to length of README, but hopefully clearer! (I didn't refactor the regular expression support in with the rest of the options. Future work.) (I think we should add a table of contents, but after tidying more of the README so the headings make better sense. Future work.) |
Looks much better. 👍 |
I had a look at "Insights > Traffic" and am surprised how much traffic Since the examples are being used, I think I'll add some more info to the new example files I added like "as shown in README", and add the expected output in a comment. However, this PR can be reviewed or merged before I do that, as examples can be added separately. |
One suggestion.
Until now, I still don't fully understand how this option I accidentally wrote a code as below (without
Then this option doesn't work as expected. But I am not sure what should be put, currently just copy it as |
Thanks @ozbillwang. I have in the early description:
but do not clarify when describing default values:
Is it mainly the default values case you tripped over? Or do you think it would be helpful to expand on "takes a value" in both places? |
(Updated examples to include README reference and example output.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! 👍
Mainly rewriting options coverage in README:
<value>
[value]
separately under "other" typesnew Command
(DocumentCommand
class in readme #790)Still to come: small changes to version option description
Comments welcome from anyone.