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

More on tutorial #24

Merged
merged 1 commit into from Apr 22, 2021
Merged

More on tutorial #24

merged 1 commit into from Apr 22, 2021

Conversation

BurdetteLamar
Copy link
Member

  • Adds section "Parsing" to tutorial.rdoc.
  • Removes section "Terminators" from option_params.rdoc. (Terminator '--' is not an option parameter.)

@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Apr 22, 2021
olleolleolle
olleolleolle approved these changes Apr 22, 2021
View reviewed changes
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.

The way the terminator section was folded into the main story of the parse methods was fluent and good.

doc/optparse/option_params.rdoc
:include: ruby/terminator.rb

The first execution fails because <tt>--nosuch</tt> is not a defined option;
the second succeeds because <tt>--</tt> causes that option to be ignored:
Copy link
Contributor

Choose a reason for hiding this comment

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

Removing this section also dropped an inconsistent naming (--nosuch/--other_option).

Copy link
Member Author

Choose a reason for hiding this comment

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

Removing this section also dropped an inconsistent naming (--nosuch/--other_option).

Not sure what you mean. Is this drop ok?

Copy link
Contributor

Choose a reason for hiding this comment

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

It is excellent is what I mean.

Copy link
Member Author

Choose a reason for hiding this comment

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

K, thanks!

@BurdetteLamar BurdetteLamar merged commit 40d51cc into ruby:master Apr 22, 2021
matzbot pushed a commit to ruby/ruby that referenced this pull request Jul 28, 2021
@BurdetteLamar @hsbt
[ruby/optparse] More on tutorial (ruby/optparse#24)
1333620 
- Adds section "Parsing" to tutorial.rdoc.
- Removes section "Terminators" from option_params.rdoc. (Terminator '--' is not an option parameter.)

ruby/optparse@40d51ccbad
nobu
nobu reviewed Jul 30, 2023
View reviewed changes
doc/optparse/tutorial.rdoc
@@ -55,7 +55,14 @@ The class also has method #help, which displays automatically-generated help tex
- {Argument Converters}[#label-Argument+Converters]
- {Help}[#label-Help]
- {Top List and Base List}[#label-Top+List+and+Base+List]
- {Methods for Defining Options}[#label-Methods+for+Defining+Options]
- {Defining Options}[#label-Defining+Options]
Copy link
Member

Choose a reason for hiding this comment

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

This label conflicts with another line.

@nobu nobu mentioned this pull request Jul 30, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olleolleolle olleolleolle olleolleolle approved these changes

@nobu nobu nobu left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@BurdetteLamar @olleolleolle @nobu