ruby-changes:28267
From: zzak <ko1@a...>
Date: Tue, 16 Apr 2013 12:26:04 +0900 (JST)
Subject: [ruby-changes:28267] zzak:r40319 (trunk): * ext/socket/option.c: Document synonymous methods, by windwiny [GH-277]
zzak 2013-04-16 12:25:50 +0900 (Tue, 16 Apr 2013) New Revision: 40319 http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=40319 Log: * ext/socket/option.c: Document synonymous methods, by windwiny [GH-277] * ext/stringio/stringio.c: ditto * ext/io/wait/wait.c: ditto * ext/gdbm/gdbm.c: ditto * ext/dl/cfunc.c: ditto * ext/zlib/zlib.c: ditto * ext/win32ole/win32ole.c: ditto * ext/dbm/dbm.c: ditto * ext/json/generator/generator.c: ditto * ext/date/date_core.c: ditto Modified files: trunk/ChangeLog trunk/ext/date/date_core.c trunk/ext/dbm/dbm.c trunk/ext/dl/cfunc.c trunk/ext/gdbm/gdbm.c trunk/ext/io/wait/wait.c trunk/ext/json/generator/generator.c trunk/ext/socket/option.c trunk/ext/stringio/stringio.c trunk/ext/win32ole/win32ole.c trunk/ext/zlib/zlib.c Index: ChangeLog =================================================================== --- ChangeLog (revision 40318) +++ ChangeLog (revision 40319) @@ -1,3 +1,16 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1 +Tue Apr 16 12:25:00 2013 Zachary Scott <zachary@z...> + + * ext/socket/option.c: Document synonymous methods, by windwiny [GH-277] + * ext/stringio/stringio.c: ditto + * ext/io/wait/wait.c: ditto + * ext/gdbm/gdbm.c: ditto + * ext/dl/cfunc.c: ditto + * ext/zlib/zlib.c: ditto + * ext/win32ole/win32ole.c: ditto + * ext/dbm/dbm.c: ditto + * ext/json/generator/generator.c: ditto + * ext/date/date_core.c: ditto + Tue Apr 16 11:23:00 2013 Zachary Scott <zachary@z...> * ext/openssl/*: Document synonymous methods, by windwiny [GH-277] Index: ext/dl/cfunc.c =================================================================== --- ext/dl/cfunc.c (revision 40318) +++ ext/dl/cfunc.c (revision 40319) @@ -285,7 +285,9 @@ rb_dlcfunc_set_ptr(VALUE self, VALUE add https://github.com/ruby/ruby/blob/trunk/ext/dl/cfunc.c#L285 } /* - * call-seq: inspect + * call-seq: + * inspect + * to_s * * Returns a string formatted with an easily readable representation of the * internal state of the DL::CFunc Index: ext/zlib/zlib.c =================================================================== --- ext/zlib/zlib.c (revision 40318) +++ ext/zlib/zlib.c (revision 40319) @@ -1293,12 +1293,8 @@ rb_zstream_finish(VALUE obj) https://github.com/ruby/ruby/blob/trunk/ext/zlib/zlib.c#L1293 /* * call-seq: - * flush_next_out -> String - * flush_next_out { |chunk| ... } -> nil + * flush_next_in -> input * - * Flushes output buffer and returns all data in that buffer. If a block is - * given each chunk is yielded to the block until the current output buffer - * has been flushed. */ static VALUE rb_zstream_flush_next_in(VALUE obj) @@ -1313,7 +1309,13 @@ rb_zstream_flush_next_in(VALUE obj) https://github.com/ruby/ruby/blob/trunk/ext/zlib/zlib.c#L1309 } /* - * Flushes output buffer and returns all data in that buffer. + * call-seq: + * flush_next_out -> String + * flush_next_out { |chunk| ... } -> nil + * + * Flushes output buffer and returns all data in that buffer. If a block is + * given each chunk is yielded to the block until the current output buffer + * has been flushed. */ static VALUE rb_zstream_flush_next_out(VALUE obj) Index: ext/win32ole/win32ole.c =================================================================== --- ext/win32ole/win32ole.c (revision 40318) +++ ext/win32ole/win32ole.c (revision 40319) @@ -5752,7 +5752,7 @@ ole_type_visible(ITypeInfo *pTypeInfo) https://github.com/ruby/ruby/blob/trunk/ext/win32ole/win32ole.c#L5752 /* * call-seq: - * WIN32OLE_TYPE#visible #=> true or false + * WIN32OLE_TYPE#visible? #=> true or false * * Returns true if the OLE class is public. * tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Application') Index: ext/json/generator/generator.c =================================================================== --- ext/json/generator/generator.c (revision 40318) +++ ext/json/generator/generator.c (revision 40319) @@ -1178,11 +1178,11 @@ static VALUE cState_array_nl_set(VALUE s https://github.com/ruby/ruby/blob/trunk/ext/json/generator/generator.c#L1178 /* -* call-seq: check_circular? -* -* Returns true, if circular data structures should be checked, -* otherwise returns false. -*/ + * call-seq: check_circular? + * + * Returns true, if circular data structures should be checked, + * otherwise returns false. + */ static VALUE cState_check_circular_p(VALUE self) { GET_STATE(self); Index: ext/date/date_core.c =================================================================== --- ext/date/date_core.c (revision 40318) +++ ext/date/date_core.c (revision 40319) @@ -5935,6 +5935,7 @@ d_lite_prev_day(int argc, VALUE *argv, V https://github.com/ruby/ruby/blob/trunk/ext/date/date_core.c#L5935 /* * call-seq: + * d.succ -> date * d.next -> date * * Returns a date object denoting the following day. Index: ext/socket/option.c =================================================================== --- ext/socket/option.c (revision 40318) +++ ext/socket/option.c (revision 40319) @@ -127,6 +127,7 @@ sockopt_optname_m(VALUE self) https://github.com/ruby/ruby/blob/trunk/ext/socket/option.c#L127 /* * call-seq: * sockopt.data => string + * sockopt.to_s => string * * returns the socket option data as a string. * Index: ext/stringio/stringio.c =================================================================== --- ext/stringio/stringio.c (revision 40318) +++ ext/stringio/stringio.c (revision 40319) @@ -1331,6 +1331,8 @@ strio_read(int argc, VALUE *argv, VALUE https://github.com/ruby/ruby/blob/trunk/ext/stringio/stringio.c#L1331 /* * call-seq: * strio.sysread(integer[, outbuf]) -> string + * strio.readpartial(integer[, outbuf]) -> string + * strio.read_nonblock(integer[, outbuf]) -> string * * Similar to #read, but raises +EOFError+ at end of string instead of * returning +nil+, as well as IO#sysread does. @@ -1363,6 +1365,7 @@ strio_sysread(int argc, VALUE *argv, VAL https://github.com/ruby/ruby/blob/trunk/ext/stringio/stringio.c#L1365 /* * call-seq: + * strio.length -> integer * strio.size -> integer * * Returns the size of the buffer string. Index: ext/dbm/dbm.c =================================================================== --- ext/dbm/dbm.c (revision 40318) +++ ext/dbm/dbm.c (revision 40319) @@ -655,6 +655,7 @@ fdbm_store(VALUE obj, VALUE keystr, VALU https://github.com/ruby/ruby/blob/trunk/ext/dbm/dbm.c#L655 /* * call-seq: * dbm.length -> integer + * dbm.size -> integer * * Returns the number of entries in the database. */ @@ -832,7 +833,10 @@ fdbm_values(VALUE obj) https://github.com/ruby/ruby/blob/trunk/ext/dbm/dbm.c#L833 /* * call-seq: + * dbm.include?(key) -> boolean * dbm.has_key?(key) -> boolean + * dbm.member?(key) -> boolean + * dbm.key?(key) -> boolean * * Returns true if the database contains the specified key, false otherwise. */ @@ -859,6 +863,7 @@ fdbm_has_key(VALUE obj, VALUE keystr) https://github.com/ruby/ruby/blob/trunk/ext/dbm/dbm.c#L863 /* * call-seq: * dbm.has_value?(value) -> boolean + * dbm.value?(value) -> boolean * * Returns true if the database contains the specified string value, false * otherwise. Index: ext/io/wait/wait.c =================================================================== --- ext/io/wait/wait.c (revision 40318) +++ ext/io/wait/wait.c (revision 40319) @@ -96,6 +96,8 @@ io_ready_p(VALUE io) https://github.com/ruby/ruby/blob/trunk/ext/io/wait/wait.c#L96 * call-seq: * io.wait -> IO, true, false or nil * io.wait(timeout) -> IO, true, false or nil + * io.wait_readable -> IO, true, false or nil + * io.wait_readable(timeout) -> IO, true, false or nil * * Waits until input is available or times out and returns self or nil when * EOF is reached. Index: ext/gdbm/gdbm.c =================================================================== --- ext/gdbm/gdbm.c (revision 40318) +++ ext/gdbm/gdbm.c (revision 40319) @@ -953,7 +953,9 @@ fgdbm_values(VALUE obj) https://github.com/ruby/ruby/blob/trunk/ext/gdbm/gdbm.c#L953 /* * call-seq: + * gdbm.include?(k) -> true or false * gdbm.has_key?(k) -> true or false + * gdbm.member?(k) -> true or false * gdbm.key?(k) -> true or false * * Returns true if the given key _k_ exists within the database. -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/