Project

General

Profile

Bug #9294

Documentation for IO#read claims resulting string is always ASCII-8BIT encoding

Added by steenslag (siep korteling) almost 6 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
2.0.0p247
[ruby-core:59305]

Description

Documentation for IO#read claims resulting string is always ASCII-8BIT encoding. This is not true (anymore).(http://www.ruby-doc.org/core-2.0.0/IO.html#method-i-read)

Associated revisions

Revision 58008
Added by stomar (Marcus Stollsteimer) over 2 years ago

io.c: improve docs

  • io.c: [DOC] improve and harmonize docs for IO#read and ARGF#read;
    fix invalid example code for IO#read to make it syntax highlighted.

  • io.c: [DOC] various improvements for docs of IO, ARGF, and Kernel:
    fix indent to ensure correct code block detection; sync "outbuf"
    paragraph for {IO,ARGF}#read, {IO,ARGF}#readpartial, and IO#sysread;
    fix formatting of call-seq's; improve Kernel#open example to use nil?;
    fix RDoc markup and typos.

Revision b41259dc
Added by usa (Usaku NAKAMURA) over 2 years ago

merge revision(s) 58008: [Backport #9294]

    io.c: improve docs

    * io.c: [DOC] improve and harmonize docs for IO#read and ARGF#read;
      fix invalid example code for IO#read to make it syntax highlighted.

    * io.c: [DOC] various improvements for docs of IO, ARGF, and Kernel:
      fix indent to ensure correct code block detection; sync "outbuf"
      paragraph for {IO,ARGF}#read, {IO,ARGF}#readpartial, and IO#sysread;
      fix formatting of call-seq's; improve Kernel#open example to use nil?;
      fix RDoc markup and typos.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_2@58127 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 58127
Added by usa (Usaku NAKAMURA) over 2 years ago

merge revision(s) 58008: [Backport #9294]

io.c: improve docs

* io.c: [DOC] improve and harmonize docs for IO#read and ARGF#read;
  fix invalid example code for IO#read to make it syntax highlighted.

* io.c: [DOC] various improvements for docs of IO, ARGF, and Kernel:
  fix indent to ensure correct code block detection; sync "outbuf"
  paragraph for {IO,ARGF}#read, {IO,ARGF}#readpartial, and IO#sysread;
  fix formatting of call-seq's; improve Kernel#open example to use nil?;
  fix RDoc markup and typos.

Revision 6920c438
Added by nagachika (Tomoyuki Chikanaga) over 2 years ago

merge revision(s) 58008: [Backport #9294]

    io.c: improve docs

    * io.c: [DOC] improve and harmonize docs for IO#read and ARGF#read;
      fix invalid example code for IO#read to make it syntax highlighted.

    * io.c: [DOC] various improvements for docs of IO, ARGF, and Kernel:
      fix indent to ensure correct code block detection; sync "outbuf"
      paragraph for {IO,ARGF}#read, {IO,ARGF}#readpartial, and IO#sysread;
      fix formatting of call-seq's; improve Kernel#open example to use nil?;
      fix RDoc markup and typos.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_3@58169 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 58169
Added by nagachika (Tomoyuki Chikanaga) over 2 years ago

merge revision(s) 58008: [Backport #9294]

io.c: improve docs

* io.c: [DOC] improve and harmonize docs for IO#read and ARGF#read;
  fix invalid example code for IO#read to make it syntax highlighted.

* io.c: [DOC] various improvements for docs of IO, ARGF, and Kernel:
  fix indent to ensure correct code block detection; sync "outbuf"
  paragraph for {IO,ARGF}#read, {IO,ARGF}#readpartial, and IO#sysread;
  fix formatting of call-seq's; improve Kernel#open example to use nil?;
  fix RDoc markup and typos.

Revision b2575bc8
Added by nagachika (Tomoyuki Chikanaga) over 2 years ago

merge revision(s) 58008: [Backport #9294]

    io.c: improve docs

    * io.c: [DOC] improve and harmonize docs for IO#read and ARGF#read;
      fix invalid example code for IO#read to make it syntax highlighted.

    * io.c: [DOC] various improvements for docs of IO, ARGF, and Kernel:
      fix indent to ensure correct code block detection; sync "outbuf"
      paragraph for {IO,ARGF}#read, {IO,ARGF}#readpartial, and IO#sysread;
      fix formatting of call-seq's; improve Kernel#open example to use nil?;
      fix RDoc markup and typos.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_4@58628 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 58628
Added by nagachika (Tomoyuki Chikanaga) over 2 years ago

merge revision(s) 58008: [Backport #9294]

io.c: improve docs

* io.c: [DOC] improve and harmonize docs for IO#read and ARGF#read;
  fix invalid example code for IO#read to make it syntax highlighted.

* io.c: [DOC] various improvements for docs of IO, ARGF, and Kernel:
  fix indent to ensure correct code block detection; sync "outbuf"
  paragraph for {IO,ARGF}#read, {IO,ARGF}#readpartial, and IO#sysread;
  fix formatting of call-seq's; improve Kernel#open example to use nil?;
  fix RDoc markup and typos.

History

Updated by zzak (Zachary Scott) almost 6 years ago

  • Category set to doc
  • Status changed from Open to Assigned
  • Assignee set to zzak (Zachary Scott)

Thanks, I'll take a look when I get a chance.

Updated by stomar (Marcus Stollsteimer) over 2 years ago

  • Backport changed from 1.9.3: UNKNOWN, 2.0.0: UNKNOWN, 2.1: UNKNOWN to 2.2: UNKNOWN, 2.3: UNKNOWN, 2.4: UNKNOWN
  • Status changed from Assigned to Closed

steenslag (siep korteling) wrote:

Documentation for IO#read claims resulting string is always ASCII-8BIT encoding.

This statement refers only to the case that an integer length argument is provided; then binmode is used and the resulting string is always ASCII-8BIT.

I tried to clarify this further in r58008 ("In the case of an integer length, the resulting string is always in ASCII-8BIT encoding.").

#3

Updated by usa (Usaku NAKAMURA) over 2 years ago

  • Backport changed from 2.2: UNKNOWN, 2.3: UNKNOWN, 2.4: UNKNOWN to 2.2: REQUIRED, 2.3: REQUIRED, 2.4: REQUIRED

Updated by usa (Usaku NAKAMURA) over 2 years ago

  • Backport changed from 2.2: REQUIRED, 2.3: REQUIRED, 2.4: REQUIRED to 2.2: DONE, 2.3: REQUIRED, 2.4: REQUIRED

ruby_2_2 r58127 merged revision(s) 58008.

Updated by nagachika (Tomoyuki Chikanaga) over 2 years ago

  • Backport changed from 2.2: DONE, 2.3: REQUIRED, 2.4: REQUIRED to 2.2: DONE, 2.3: DONE, 2.4: REQUIRED

ruby_2_3 r58169 merged revision(s) 58008.

Updated by nagachika (Tomoyuki Chikanaga) over 2 years ago

  • Backport changed from 2.2: DONE, 2.3: DONE, 2.4: REQUIRED to 2.2: DONE, 2.3: DONE, 2.4: DONE

ruby_2_4 r58628 merged revision(s) 58008.

Also available in: Atom PDF