diff options
| -rw-r--r-- | ChangeLog | 6 | ||||
| -rw-r--r-- | lib/optparse.rb | 37 |
2 files changed, 43 insertions, 0 deletions
@@ -1,3 +1,9 @@ +Thu Feb 27 17:59:01 2014 Zachary Scott <e@zzak.io> + + * lib/optparse.rb: [DOC] Add example of generating help with optparse. + Patch by @joelmccracken documenting-ruby/ruby#19 + https://github.com/documenting-ruby/ruby/pull/19 + Thu Feb 27 12:10:09 2014 Nobuyoshi Nakada <nobu@ruby-lang.org> * numeric.c (ruby_num_interval_step_size): check signs and get rid diff --git a/lib/optparse.rb b/lib/optparse.rb index 6c4560f749..27490204df 100644 --- a/lib/optparse.rb +++ b/lib/optparse.rb @@ -82,6 +82,43 @@ # p options # p ARGV # +# === Generating Help +# +# OptionParser can be used to automatically generate help for the commands you +# write: +# +# require 'optparse' +# +# Options = Struct.new(:name) +# +# class Parser +# def self.parse(options) +# args = Options.new("world") +# +# opt_parser = OptionParser.new do |opts| +# opts.banner = "Usage: example.rb [options]" +# +# opts.on("-nNAME", "--name=NAME", "Name to say hello to") do |n| +# args.name = n +# end +# +# opts.on("-h", "--help", "Prints this help") do +# puts opts +# exit +# end +# end +# +# opt_parser.parse!(options) +# return args +# end +# end +# options = Parser.parse %w[--help] +# +# #=> +# # Usage: example.rb [options] +# # -n, --name=NAME Name to say hello to +# # -h, --help Prints this help# +# # === Complete example # # The following example is a complete Ruby program. You can run it and see the |