From: "stomar (Marcus Stollsteimer)" <redmine@...>
Date: 2012-12-22T19:51:07+09:00
Subject: [ruby-core:51075] [ruby-trunk - Bug #6997] Improve documentation for OptionParser


Issue #6997 has been updated by stomar (Marcus Stollsteimer).

File rdoc_lib_optparse.patch added

I tried to make this clearer, see patch.
I also changed the example to avoid a warning for "shadowed outer local variable".

@zzak: Do you think that the "Further documentation" section is of any use in the current form (since changeset r36960)? I would suggest to remove it completely, since filing a ticket for usage questions seems not the right thing to do.
----------------------------------------
Bug #6997: Improve documentation for OptionParser
https://bugs.ruby-lang.org/issues/6997#change-35007

Author: eike.rb (Eike Dierks)
Status: Assigned
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: ruby 1.9.3p194 (2012-04-20 revision 35410) [x86_64-darwin10]


The documentation for OptionParser should be improved.

The current examples and and documentation do not yet describe
how to access non option args

I suggest to change the simple example in the doc as follows:

   opts.banner = "Usage: example.rb [options] file ..."

   p "files:" + ARGV


It should be stated explicitely in the description,
that parse! modifies the ARGV and removes all parseable args.

At least that is how I believe that the OptionParser.parse! works?
not yet tried it myself












-- 
http://bugs.ruby-lang.org/