Project

General

Profile

Actions

Bug #10526

closed

[DOC] Revise documentation in object.c

Added by stomar (Marcus Stollsteimer) over 10 years ago. Updated over 10 years ago.

Status:
Closed
Assignee:
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

Updated by stomar (Marcus Stollsteimer) over 10 years ago

Adding a patch based on the latest trunk, replacing the originally submitted one.

Updated by stomar (Marcus Stollsteimer) over 10 years ago

@zzak (zzak _) Please change assignee if you are the wrong person.

Nearly two weeks without feedback... are DOC fixes also affected by freeze for 2.2.0?

Updated by nobu (Nobuyoshi Nakada) over 10 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

Applied in changeset r48746.


object.c: [DOC] Revise documentation

  • object.c: [DOC] Revise documentation by Marcus Stollsteimer at
    [ruby-core:66368]. [Bug #10526]
    • #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.
Actions #4

Updated by usa (Usaku NAKAMURA) over 10 years ago

  • Backport changed from 2.0.0: UNKNOWN, 2.1: UNKNOWN to 2.0.0: REQUIRED, 2.1: REQUIRED

Updated by nagachika (Tomoyuki Chikanaga) over 10 years ago

  • Backport changed from 2.0.0: REQUIRED, 2.1: REQUIRED to 2.0.0: REQUIRED, 2.1: DONE

r45375,r48260,r48320 and r48746 were backported into ruby_2_1 at r49367.

r45375,r48260,r48320 are also documentation fix and need to resolve conflicts.

Updated by usa (Usaku NAKAMURA) over 10 years ago

  • Backport changed from 2.0.0: REQUIRED, 2.1: DONE to 2.0.0: DONE, 2.1: DONE
Actions

Also available in: Atom PDF

Like0
Like0Like0Like0Like0Like0Like0