Project

General

Profile

Actions

Bug #4790

closed

[rdoc] attempt to clarify IO rdocs

Added by rogerdpack (Roger Pack) over 11 years ago. Updated over 11 years ago.

Status:
Closed
Priority:
Normal
Target version:
ruby -v:
1.9.3
Backport:
[ruby-core:36515]

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


Files

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

Updated by drbrain (Eric Hodel) over 11 years ago

  • Category set to doc
  • Target version set to 1.9.3

Updated by vbatts (Vincent Batts) over 11 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.

Updated by rogerdpack (Roger Pack) over 11 years ago

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

Actions #4

Updated by drbrain (Eric Hodel) over 11 years ago

  • File deleted (io_rdoc.diff)

Updated by drbrain (Eric Hodel) over 11 years ago

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

Actions #6

Updated by drbrain (Eric Hodel) over 11 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]
Actions

Also available in: Atom PDF

Like0
Like0Like0Like0Like0Like0Like0