From 43af561e0878ca856513edd3db56ce7dff8e7fe3 Mon Sep 17 00:00:00 2001 From: Burdette Lamar Date: Mon, 12 Apr 2021 20:33:19 -0500 Subject: [ruby/optparse] Rdoc for help (https://github.com/ruby/optparse/pull/21) https://github.com/ruby/optparse/commit/d07cb96a96 --- doc/optparse/ruby/help.rb | 21 +++++++++++++++++++++ doc/optparse/ruby/help_banner.rb | 7 +++++++ doc/optparse/ruby/help_format.rb | 25 +++++++++++++++++++++++++ doc/optparse/ruby/help_program_name.rb | 7 +++++++ 4 files changed, 60 insertions(+) create mode 100644 doc/optparse/ruby/help.rb create mode 100644 doc/optparse/ruby/help_banner.rb create mode 100644 doc/optparse/ruby/help_format.rb create mode 100644 doc/optparse/ruby/help_program_name.rb (limited to 'doc/optparse/ruby') diff --git a/doc/optparse/ruby/help.rb b/doc/optparse/ruby/help.rb new file mode 100644 index 0000000000..72f1b93527 --- /dev/null +++ b/doc/optparse/ruby/help.rb @@ -0,0 +1,21 @@ +require 'optparse' +parser = OptionParser.new +parser.on( + '-x', '--xxx', + 'Adipiscing elit. Aenean commodo ligula eget.', + 'Aenean massa. Cum sociis natoque penatibus', + ) +parser.on( + '-y', '--yyy YYY', + 'Lorem ipsum dolor sit amet, consectetuer.' +) +parser.on( + '-z', '--zzz [ZZZ]', + 'Et magnis dis parturient montes, nascetur', + 'ridiculus mus. Donec quam felis, ultricies', + 'nec, pellentesque eu, pretium quis, sem.', + ) +parser.parse! + + + diff --git a/doc/optparse/ruby/help_banner.rb b/doc/optparse/ruby/help_banner.rb new file mode 100644 index 0000000000..0943a3e029 --- /dev/null +++ b/doc/optparse/ruby/help_banner.rb @@ -0,0 +1,7 @@ +require 'optparse' +parser = OptionParser.new +parser.banner = "Usage: ruby help_banner.rb" +parser.parse! + + + diff --git a/doc/optparse/ruby/help_format.rb b/doc/optparse/ruby/help_format.rb new file mode 100644 index 0000000000..a2f1e85b00 --- /dev/null +++ b/doc/optparse/ruby/help_format.rb @@ -0,0 +1,25 @@ +require 'optparse' +parser = OptionParser.new( + 'ruby help_format.rb [options]', # Banner + 20, # Width of options field + ' ' * 2 # Indentation +) +parser.on( + '-x', '--xxx', + 'Adipiscing elit. Aenean commodo ligula eget.', + 'Aenean massa. Cum sociis natoque penatibus', + ) +parser.on( + '-y', '--yyy YYY', + 'Lorem ipsum dolor sit amet, consectetuer.' +) +parser.on( + '-z', '--zzz [ZZZ]', + 'Et magnis dis parturient montes, nascetur', + 'ridiculus mus. Donec quam felis, ultricies', + 'nec, pellentesque eu, pretium quis, sem.', + ) +parser.parse! + + + diff --git a/doc/optparse/ruby/help_program_name.rb b/doc/optparse/ruby/help_program_name.rb new file mode 100644 index 0000000000..7b3fbff067 --- /dev/null +++ b/doc/optparse/ruby/help_program_name.rb @@ -0,0 +1,7 @@ +require 'optparse' +parser = OptionParser.new +parser.program_name = 'help_program_name.rb' +parser.parse! + + + -- cgit v1.2.3