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

Enhanced doc for option parameters #11

Merged
merged 2 commits into from
Apr 7, 2021
Merged

Enhanced doc for option parameters #11

merged 2 commits into from
Apr 7, 2021

Conversation

BurdetteLamar
Copy link
Member

@BurdetteLamar BurdetteLamar commented Apr 6, 2021

This separate-page write-up for option parameters is meant to:

  • Provide examples for all option parameters.
  • Provide link targets for all other references to option parameters.

The sense of this page is to explicate what the option-creating methods can do.

The sense of the (evolving) tutorial page is to explicate what the user can do.

This PR is big, so if you'd like to review just part of it, please say so in a comment.

Copy link
Contributor

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read the whole thing, now, and I made small notes where I could not immediately get what was going on. Mostly because I'm not perfectly familiar with all the options, and I learned things while reading it.

Thanks so much for doing this change. It was this month that I needed to have good documentation on how optional options were to be written - and now you've gone and fixed that!

@BurdetteLamar
Copy link
Member Author

I read the whole thing, now, and I made small notes where I could not immediately get what was going on. Mostly because I'm not perfectly familiar with all the options, and I learned things while reading it.

Thanks so much for doing this change. It was this month that I needed to have good documentation on how optional options were to be written - and now you've gone and fixed that!

Glad if it helps. My current mission is to make important tools more accessible. An earlier project was doc for CSV. Now comes doc for OptionParser.

Copy link
Contributor

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each of my inline questions was answered, and the one edit was committed. This is ready to go, as far as I can see.

@BurdetteLamar
Copy link
Member Author

@olleolleolle, are you a Ruby committer? If so, you can merge this.

@olleolleolle olleolleolle merged commit 5618eeb into ruby:master Apr 7, 2021
@BurdetteLamar BurdetteLamar deleted the option_params branch April 7, 2021 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants