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.

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 #1

Conversation

shadowspawn
Copy link

Pull Request

Try a new terminology, reword, and expand examples of alternative approaches.

Making a PR to you! Feel free to comment here so you comment on specific lines, or in your PR going the other way. 😄

@shadowspawn
Copy link
Author

Worked through entire doc. I left out variadic example as I didn't think it added enough (although I liked the example scenario), but I added a comment at top that using 0-1 arguments in examples.

I have wondered about showing how to specify an option-argument starting with a - (or potential parsing surprise), but it wasn't part of my main goals for this story so left out.

@shadowspawn shadowspawn changed the title Refactor and expand intro and parse ambiguity Rework Sep 4, 2020
@shadowspawn
Copy link
Author

I was working on wrong branch in my fork (oops), so all the subsequent changes have arrived here in one commit when I copied content, and GitHub is not tracking the file rename so showing new files and old file and not a diff as such.

@shadowspawn
Copy link
Author

Any comments @heyjiawei ?

I have been thinking about these issue most of this year, so apologies that lots of changes to what you wrote! But your start got this underway, and got me rethinking the terminology as you asked questions and I tried to answer.

@heyjiawei
Copy link
Owner

Hello hello @shadowspawn I have read the changes and I like how neat it is! I have no issues with the changes, just wondering if we should mention tj#1332 (comment)

Commander follows the GNU convention and allows options before or after the operands. So by putting the options last, the option values do not get confused with the operands.

@shadowspawn
Copy link
Author

That is mentioned in "Alternative: Put options last"

@heyjiawei
Copy link
Owner

oh yes. Alright looks good to me

@heyjiawei heyjiawei merged commit 0b5f249 into heyjiawei:optional-options-docs Sep 13, 2020
@shadowspawn shadowspawn deleted the feature/more-about-options-fork branch September 13, 2020 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants