From: Eric Hodel <drbrain@...7.net>
Date: 2011-05-17T06:26:10+09:00
Subject: [ruby-core:36238] [Ruby 1.9 - Bug #4704] Clean up and complete CGI documentation (patch included)


Issue #4704 has been updated by Eric Hodel.


I made a few additions to this patch to bring in the toplevel CGI documentation and include the overviews.

For the nested labeled lists I undented them quite a bit.  For example:

foo:: blah blah
      bar:: blah blah

To:

foo::
  blah blah

  bar:: blah blah

See the committed diff above for the actual changes.
----------------------------------------
Bug #4704: Clean up and complete CGI documentation (patch included)
http://redmine.ruby-lang.org/issues/4704

Author: David Copeland
Status: Closed
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 
ruby -v: ruby 1.9.3dev (2011-05-16 trunk 31583) [x86_64-darwin10.7.0] 


CGI's documentation has a few issues:

* Some RDoc is in the wrong place (e.g. Cookie's)
* Some is inconsistently worded or has grammar issues
* Some methods/attributes aren't documented at all

This patch addresses all of that, in addition to using :call-seq: to explain the different ways to call various methods.


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