Bug #4790

[rdoc] attempt to clarify IO rdocs

Added by Roger Pack almost 3 years ago. Updated almost 3 years ago.

[ruby-core:36515]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:1.9.3 Backport:

Description

As per some confusion over options for File.open [1], here is a patch to attempt to clarify.

[1] http://www.ruby-forum.com/topic/1731075

io_rdoc2.diff Magnifier (1.63 KB) Roger Pack, 06/17/2011 06:35 AM

Associated revisions

Revision 32142
Added by Eric Hodel almost 3 years ago

  • io.c: Improve documentation of IO and File open and new. Patch by Roger Pack. [Ruby 1.9 - Bug #4790]

History

#1 Updated by Eric Hodel almost 3 years ago

  • Category set to doc
  • Target version set to 1.9.3

#2 Updated by Vincent Batts almost 3 years ago

Looks pretty good, but a couple of the tags are not closed, or not properly closed.
i.e. "See File."
or
"IO.new"

Otherwise, it's okay.

#3 Updated by Roger Pack almost 3 years ago

Uploading new version of the patch with better terminated HTML strings.
Thanks!
-roger-

#4 Updated by Eric Hodel almost 3 years ago

  • File deleted (io_rdoc.diff)

#5 Updated by Eric Hodel almost 3 years ago

I removed some of the code elements from the documentation to improve cross-references between the various methods.

#6 Updated by Eric Hodel almost 3 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r32142.
Roger, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • io.c: Improve documentation of IO and File open and new. Patch by Roger Pack. [Ruby 1.9 - Bug #4790]

Also available in: Atom PDF