10000 [DOC] Corrections to tutorial by BurdetteLamar · Pull Request #57 · ruby/optparse · GitHub
[go: up one dir, main page]

Skip to content

[DOC] Corrections to tutorial #57

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

Merged
merged 1 commit into from
Jul 31, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions doc/optparse/tutorial.rdoc
5C3C
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ 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]
- {Defining Options}[#label-Defining+Options]
- {Methods for Defining Options}[#label-Methods+for+Defining+Options]
- {Parsing}[#label-Parsing]
- {Method parse!}[#label-Method+parse-21]
- {Method parse}[#label-Method+parse]
Expand Down Expand Up @@ -614,49 +614,49 @@ Execution:

=== Top List and Base List

An +OptionParser+ object maintains a stack of +OptionParser::List+ objects,
An +OptionParser+ object maintains a stack of OptionParser::List objects,
each of which has a collection of zero or more options.
It is unlikely that you'll need to add or take away from that stack.

The stack includes:

- The <em>top list</em>, given by +OptionParser#top+.
- The <em>base list</em>, given by +OptionParser#base+.
- The <em>top list</em>, given by OptionParser#top.
- The <em>base list</em>, given by OptionParser#base.

When +OptionParser+ builds its help text, the options in the top list
precede those in the base list.

=== Defining Options
=== Methods for Defining Options

Option-defining methods allow you to create an option, and also append/prepend it
to the top list or append it to the base list.

Each of these next three methods accepts a sequence of parameter arguments and a block,
creates an option object using method +Option#make_switch+ (see below),
creates an option object using method OptionParser#make_switch (see below),
and returns the created option:

- \Method +OptionParser#define+ appends the created option to the top list.
- \Method OptionParser#define appends the created option to the top list.

- \Method +OptionParser#define_head+ prepends the created option to the top list.
- \Method OptionParser#define_head prepends the created option to the top list.

- \Method +OptionParser#define_tail+ appends the created option to the base list.
- \Method OptionParser#define_tail appends the created option to the base list.

These next three methods are identical to the three above,
except for their return values:

- \Method +OptionParser#on+ is identical to method +OptionParser#define+,
- \Method OptionParser#on is identical to method OptionParser#define,
except that it returns the parser object +self+.

- \Method +OptionParser#on_head+ is identical to method +OptionParser#define_head+,
- \Method OptionParser#on_head is identical to method OptionParser#define_head,
except that it returns the parser object +self+.

- \Method +OptionParser#on_tail+ is identical to method +OptionParser#define_tail+,
- \Method OptionParser#on_tail is identical to method OptionParser#define_tail,
except that it returns the parser object +self+.

Though you may never need to call it directly,
here's the core method for defining an option:

- \Method +OptionParser#make_switch+ accepts an array of parameters and a block.
- \Method OptionParser#make_switch accepts an array of parameters and a block.
See {Parameters for New Options}[optparse/option_params.rdoc].
This method is unlike others here in that it:
- Accepts an <em>array of parameters</em>;
Expand Down
0