summaryrefslogtreecommitdiff
path: root/doc/optparse/creates_option.rdoc
diff options
context:
space:
mode:
authorNobuyoshi Nakada <[email protected]>2021-04-11 09:03:07 +0900
committerNobuyoshi Nakada <[email protected]>2021-04-11 09:03:36 +0900
commitf89486965b64bc04ed49073fd5ef48390e0026d2 (patch)
treeecfcd779d8c3ea9cf479edd21865dff98aeec0b9 /doc/optparse/creates_option.rdoc
parentcb01437c24ce3f819ef15947748e3c723b9c52c6 (diff)
[ruby/optparse] Moved rdoc files to doc/optparse
https://github.com/ruby/optparse/commit/cccb28e0de
Diffstat (limited to 'doc/optparse/creates_option.rdoc')
-rw-r--r--doc/optparse/creates_option.rdoc7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/optparse/creates_option.rdoc b/doc/optparse/creates_option.rdoc
new file mode 100644
index 0000000000..aaeb72d745
--- /dev/null
+++ b/doc/optparse/creates_option.rdoc
@@ -0,0 +1,7 @@
+Creates an option from the given parameters +params+.
+See {Parameters for New Options}[./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}[./option_params_rdoc.html#label-Option+Handlers].