From ff0dac184902e42fac148940cd6c026679a0ee21 Mon Sep 17 00:00:00 2001
From: Burdette Lamar <BurdetteLamar@Yahoo.com>
Date: Sat, 10 Apr 2021 10:05:44 -0500
Subject: [ruby/optparse] Rdoc (#15)

* Resolve shared mixed_names.rb

* Add long option with negation

* Show --help for all examples

* Table of contents for tutorial

* Move argument converters to separate rdoc

* Add references to argument_converters.rdoc

* Tune up argument converters

* Change explicit links to auto-links

https://github.com/ruby/optparse/commit/c91ed8d33d
---
 doc/ruby/custom_converter.rb   | 9 +++++++++
 doc/ruby/long_binary.rb        | 6 ------
 doc/ruby/long_names.rb         | 4 ++--
 doc/ruby/long_with_negation.rb | 6 ++++++
 doc/ruby/mixed_names.rb        | 9 ++++++---
 doc/ruby/optional_argument.rb  | 4 ++--
 doc/ruby/required_argument.rb  | 4 ++--
 doc/ruby/short_names.rb        | 4 ++--
 8 files changed, 29 insertions(+), 17 deletions(-)
 create mode 100644 doc/ruby/custom_converter.rb
 delete mode 100644 doc/ruby/long_binary.rb
 create mode 100644 doc/ruby/long_with_negation.rb

(limited to 'doc/ruby')

diff --git a/doc/ruby/custom_converter.rb b/doc/ruby/custom_converter.rb
new file mode 100644
index 0000000000..029da08c46
--- /dev/null
+++ b/doc/ruby/custom_converter.rb
@@ -0,0 +1,9 @@
+require 'optparse/date'
+parser = OptionParser.new
+parser.accept(Complex) do |value|
+  value.to_c
+end
+parser.on('--complex COMPLEX', Complex) do |value|
+  p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/long_binary.rb b/doc/ruby/long_binary.rb
deleted file mode 100644
index 8eccecaf3a..0000000000
--- a/doc/ruby/long_binary.rb
+++ /dev/null
@@ -1,6 +0,0 @@
-require 'optparse'
-parser = OptionParser.new
-parser.on('--[no-]binary') do |value|
-  p [value, value.class]
-end
-parser.parse!
diff --git a/doc/ruby/long_names.rb b/doc/ruby/long_names.rb
index a34b3382c2..a49dbda69f 100644
--- a/doc/ruby/long_names.rb
+++ b/doc/ruby/long_names.rb
@@ -1,9 +1,9 @@
 require 'optparse'
 parser = OptionParser.new
-parser.on('--xxx') do |value|
+parser.on('--xxx', 'Long name') do |value|
   p ['-xxx', value]
 end
-parser.on('--y1%', '--z2#') do |value|
+parser.on('--y1%', '--z2#', "Two long names") do |value|
   p ['--y1% or --z2#', value]
 end
 parser.parse!
diff --git a/doc/ruby/long_with_negation.rb b/doc/ruby/long_with_negation.rb
new file mode 100644
index 0000000000..3f2913c361
--- /dev/null
+++ b/doc/ruby/long_with_negation.rb
@@ -0,0 +1,6 @@
+require 'optparse'
+parser = OptionParser.new
+parser.on('--[no-]binary', 'Long name with negation') do |value|
+  p [value, value.class]
+end
+parser.parse!
diff --git a/doc/ruby/mixed_names.rb b/doc/ruby/mixed_names.rb
index e886049821..67f81e7e8d 100644
--- a/doc/ruby/mixed_names.rb
+++ b/doc/ruby/mixed_names.rb
@@ -1,9 +1,12 @@
 require 'optparse'
 parser = OptionParser.new
-parser.on('-x', '--xxx') do |value|
+parser.on('-x', '--xxx', 'Short and long, no argument') do |value|
   p ['--xxx', value]
 end
-parser.on('-y', '--y1%') do |value|
-  p ['--y1%', value]
+parser.on('-yYYY', '--yyy', 'Short and long, required argument') do |value|
+  p ['--yyy', value]
+end
+parser.on('-z [ZZZ]', '--zzz', 'Short and long, optional argument') do |value|
+  p ['--zzz', value]
 end
 parser.parse!
diff --git a/doc/ruby/optional_argument.rb b/doc/ruby/optional_argument.rb
index ebff2f466d..456368a8ba 100644
--- a/doc/ruby/optional_argument.rb
+++ b/doc/ruby/optional_argument.rb
@@ -1,9 +1,9 @@
 require 'optparse'
 parser = OptionParser.new
-parser.on('-x [XXX]', '--xxx') do |value|
+parser.on('-x [XXX]', '--xxx', 'Optional argument via short  name') do |value|
   p ['--xxx', value]
 end
-parser.on('-y', '--yyy [YYY]') do |value|
+parser.on('-y', '--yyy [YYY]', 'Optional argument via long name') do |value|
   p ['--yyy', value]
 end
 parser.parse!
diff --git a/doc/ruby/required_argument.rb b/doc/ruby/required_argument.rb
index 7a5a868265..228a492c3c 100644
--- a/doc/ruby/required_argument.rb
+++ b/doc/ruby/required_argument.rb
@@ -1,9 +1,9 @@
 require 'optparse'
 parser = OptionParser.new
-parser.on('-x XXX', '--xxx') do |value|
+parser.on('-x XXX', '--xxx', 'Required argument via short name') do |value|
   p ['--xxx', value]
 end
-parser.on('-y', '--y YYY') do |value|
+parser.on('-y', '--y YYY', 'Required argument via long name') do |value|
   p ['--yyy', value]
 end
 parser.parse!
diff --git a/doc/ruby/short_names.rb b/doc/ruby/short_names.rb
index 6581dfe19a..4a756518fa 100644
--- a/doc/ruby/short_names.rb
+++ b/doc/ruby/short_names.rb
@@ -1,9 +1,9 @@
 require 'optparse'
 parser = OptionParser.new
-parser.on('-x') do |value|
+parser.on('-x', 'Short name') do |value|
   p ['x', value]
 end
-parser.on('-1', '-%') do |value|
+parser.on('-1', '-%', 'Two short names') do |value|
   p ['-1 or -%', value]
 end
 parser.parse!
-- 
cgit v1.2.3