1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* io.c (rb_io_s_read): Fix formatting of open_args comment. Reported

by Adam Prescott.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@34296 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2012-01-13 21:59:36 +00:00
parent 23b4c10dd8
commit 90943649fe
2 changed files with 21 additions and 12 deletions

View file

@ -1,3 +1,8 @@
Sat Jan 14 05:58:54 2012 Eric Hodel <drbrain@segment7.net>
* io.c (rb_io_s_read): Fix formatting of open_args comment. Reported
by Adam Prescott.
Fri Jan 13 18:41:19 2012 Nobuyoshi Nakada <nobu@ruby-lang.org>
* sprintf.c (rb_enc_vsprintf): can be used for ASCII compatible

28
io.c
View file

@ -9025,31 +9025,35 @@ seek_before_access(VALUE argp)
* IO.read(name, [length [, offset]] ) -> string
* IO.read(name, [length [, offset]], open_args) -> string
*
* Opens the file, optionally seeks to the given <i>offset</i>, then returns
* <i>length</i> bytes (defaulting to the rest of the file).
* <code>read</code> ensures the file is closed before returning.
* Opens the file, optionally seeks to the given +offset+, then returns
* +length+ bytes (defaulting to the rest of the file). <code>read</code>
* ensures the file is closed before returning.
*
* If the last argument is a hash, it specifies option for internal
* open(). The key would be the following. open_args: is exclusive
* to others.
*
* encoding: string or encoding
* encoding::
* string or encoding
*
* specifies encoding of the read string. encoding will be ignored
* specifies encoding of the read string. +encoding+ will be ignored
* if length is specified.
*
* mode: string
* mode::
* string
*
* specifies mode argument for open(). it should start with "r"
* otherwise it would cause error.
* specifies mode argument for open(). It should start with "r"
* otherwise it will cause an error.
*
* open_args: array of strings
* open_args:: array of strings
*
* specifies arguments for open() as an array.
*
* IO.read("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n"
* IO.read("testfile", 20) #=> "This is line one\nThi"
* IO.read("testfile", 20, 10) #=> "ne one\nThis is line "
* Examples:
*
* IO.read("testfile") #=> "This is line one\nThis is line two\nThis is line three\nAnd so on...\n"
* IO.read("testfile", 20) #=> "This is line one\nThi"
* IO.read("testfile", 20, 10) #=> "ne one\nThis is line "
*/
static VALUE