Bug #4790

[rdoc] attempt to clarify IO rdocs

Added by rogerdpack (Roger Pack) 12 months ago. Updated 11 months ago.

[ruby-core:36515]
Status:Closed Start date:05/28/2011
Priority:Normal Due date:
Assignee:drbrain (Eric Hodel) % Done:

100%
Category:DOC
Target version:1.9.3
ruby -v:1.9.3

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 (1.6 kB) rogerdpack (Roger Pack), 06/17/2011 06:35 am

Associated revisions

Revision 32142
Added by drbrain (Eric Hodel) 11 months ago

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

Revision 32142
Added by drbrain (Eric Hodel) 11 months ago

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

History

[ruby-core:36646]#1
Updated by drbrain (Eric Hodel) 12 months ago

  • Category set to DOC
  • Target version set to 1.9.3

[ruby-core:37148]#2
Updated by vbatts (Vincent Batts) 11 months ago

Looks pretty good, but a couple of the <code> tags are not closed, or not properly closed. i.e. "See <code>File." or "<code>IO.new<code>" Otherwise, it's okay.

[ruby-core:37183]#3
Updated by rogerdpack (Roger Pack) 11 months ago

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

#4
Updated by drbrain (Eric Hodel) 11 months ago

  • File deleted (io_rdoc.diff)

[ruby-core:37188]#5
Updated by drbrain (Eric Hodel) 11 months ago

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

#6
Updated by drbrain (Eric Hodel) 11 months 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