Project

General

Profile

Actions

Bug #10526

closed

[DOC] Revise documentation in object.c

Added by stomar (Marcus Stollsteimer) almost 7 years ago. Updated over 6 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
ruby 2.1.4p265 (2014-10-27 revision 48166) [i686-linux]
[ruby-core:66368]

Description

  • #inspect: be more specific about generated string, remove obsolete example
  • #nil?: use code examples instead of different call-seq's
  • #tap: clarify what is yielded
  • Integer(): be more specific about to_int and to_i, remove reference to Ruby 1.8
  • Array(): fix error
  • Class: fix variable name style and indentation in example
  • improve consistency, fix typos and formatting

Further notes:

regarding #inspect: since r36709 it is decoupled from #to_s, so the example is meaningless
regarding #nil?: the call-seq's are not rendered correctly on ruby-doc.org, see http://ruby-doc.org/core-2.1.5/Object.html#method-i-nil-3F


Files

doc_object_c.patch (16.7 KB) doc_object_c.patch stomar (Marcus Stollsteimer), 11/19/2014 09:28 PM
10526_doc_object_c.patch_new (16.7 KB) 10526_doc_object_c.patch_new stomar (Marcus Stollsteimer), 11/21/2014 06:48 PM
Actions

Also available in: Atom PDF