diff options
| author | BurdetteLamar <burdettelamar@yahoo.com> | 2021-04-07 11:58:46 -0500 |
|---|---|---|
| committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2021-04-08 12:11:42 +0900 |
| commit | a5ecce9187a275497895eca3fdb080ca60297931 (patch) | |
| tree | 89d6a96db17c25c42cafe0d0444676938337faaa /doc | |
| parent | 5891159f9608f058b3fb2ba96a9874fc81f3d7b3 (diff) | |
[ruby/optparse] Make use of option_params.rdoc
https://github.com/ruby/optparse/commit/d55d9284c3
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/creates_option.rdoc | 7 | ||||
| -rw-r--r-- | doc/option_params/option_params.rdoc | 4 |
2 files changed, 9 insertions, 2 deletions
diff --git a/doc/creates_option.rdoc b/doc/creates_option.rdoc new file mode 100644 index 0000000000..d006706382 --- /dev/null +++ b/doc/creates_option.rdoc @@ -0,0 +1,7 @@ +Creates an option from the given parameters +params+. +See {Parameters for New Options}[doc/option_params/option_params_rdoc.html]. + +The block, if given, is the handler for the created option. +When the option is encountered during command-line parsing, +the block is called with the argument given for the option, if any. +See {Option Handlers}[doc/option_params/option_params_rdoc.html#label-Option+Handlers]. diff --git a/doc/option_params/option_params.rdoc b/doc/option_params/option_params.rdoc index 7cf5ef890c..ebd08f1fa6 100644 --- a/doc/option_params/option_params.rdoc +++ b/doc/option_params/option_params.rdoc @@ -55,7 +55,7 @@ Contents: - {Array}[#label-Array] - {Regexp}[#label-Regexp] - {Descriptions}[#label-Descriptions] -- {Handlers}[#label-Handlers] +- {Option Handlers}[#label-Option+Handlers] - {Handler Blocks}[#label-Handler+Blocks] - {Handler Procs}[#label-Handler+Procs] - {Handler Methods}[#label-Handler+Methods] @@ -759,7 +759,7 @@ Executions: $ ruby descriptions.rb --xxx ["--xxx", true] -=== Handlers +=== Option Handlers The handler for an option is an executable that will be called when the option is encountered. The handler may be: |