From: "eike.rb (Eike Dierks)" <eike@...>
Date: 2012-09-11T05:02:11+09:00
Subject: [ruby-core:47467] [ruby-trunk - Bug #6997] Improve documentation for OptionParser


Issue #6997 has been updated by eike.rb (Eike Dierks).


Ok, I was a bit blind on that,
I think that I now do understand how it works.

But anyway, the documentation should be improved.

I'd suggest to improve the examples to make it more clear upfront.


----------------------------------------
Bug #6997: Improve documentation for OptionParser
https://bugs.ruby-lang.org/issues/6997#change-29235

Author: eike.rb (Eike Dierks)
Status: Open
Priority: Normal
Assignee: 
Category: 
Target version: 
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/