Project

General

Profile

Bug #10526

[DOC] Revise documentation in object.c

Added by stomar (Marcus Stollsteimer) over 4 years ago. Updated over 4 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

Associated revisions

Revision 9e256261
Added by nobu (Nobuyoshi Nakada) over 4 years ago

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.

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

Revision 48746
Added by nobu (Nobuyoshi Nakada) over 4 years ago

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.

Revision 48746
Added by nobu (Nobuyoshi Nakada) over 4 years ago

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.

Revision 48746
Added by nobu (Nobuyoshi Nakada) over 4 years ago

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.

Revision 48746
Added by nobu (Nobuyoshi Nakada) over 4 years ago

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.

Revision 48746
Added by nobu (Nobuyoshi Nakada) over 4 years ago

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.

Revision 48746
Added by nobu (Nobuyoshi Nakada) over 4 years ago

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.

Revision f3ac23e4
Added by nagachika (Tomoyuki Chikanaga) over 4 years ago

merge revision(s) r45375,r48260,r48320,r48746: [Backport #10526]

    * complax.c: [DOC] Document number conversion of `nil` by @skade [fix GH-570] [ci skip]

    * object.c, rational.c: ditto.
    * object.c: fix document of Kernel.Stirng by @suzukaze
      [fix GH-743][ci skip]

    * object.c (Module#const_defined?): [DOC] Revise the documentation.
      Patch by Xavier Noria.
      [Fixes GH-754] https://github.com/ruby/ruby/pull/754

    * 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.

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

Revision 49367
Added by nagachika (Tomoyuki Chikanaga) over 4 years ago

merge revision(s) r45375,r48260,r48320,r48746: [Backport #10526]

* complax.c: [DOC] Document number conversion of `nil` by @skade [fix GH-570] [ci skip]

* object.c, rational.c: ditto.
* object.c: fix document of Kernel.Stirng by @suzukaze
  [fix GH-743][ci skip]

* object.c (Module#const_defined?): [DOC] Revise the documentation.
  Patch by Xavier Noria.
  [Fixes GH-754] https://github.com/ruby/ruby/pull/754

* 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.

Revision 744408df
Added by usa (Usaku NAKAMURA) over 4 years ago

merge revision(s) 45375,48260,48320,48746: [Backport #10526]

    * complax.c: [DOC] Document number conversion of `nil` by @skade [fix GH-570] [ci skip]

    * object.c, rational.c: ditto.
    * object.c: fix document of Kernel.Stirng by @suzukaze
      [fix GH-743][ci skip]

    * object.c (Module#const_defined?): [DOC] Revise the documentation.
      Patch by Xavier Noria.
      [Fixes GH-754] https://github.com/ruby/ruby/pull/754

    * 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.

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

Revision 49448
Added by usa (Usaku NAKAMURA) over 4 years ago

merge revision(s) 45375,48260,48320,48746: [Backport #10526]

* complax.c: [DOC] Document number conversion of `nil` by @skade [fix GH-570] [ci skip]

* object.c, rational.c: ditto.
* object.c: fix document of Kernel.Stirng by @suzukaze
  [fix GH-743][ci skip]

* object.c (Module#const_defined?): [DOC] Revise the documentation.
  Patch by Xavier Noria.
  [Fixes GH-754] https://github.com/ruby/ruby/pull/754

* 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.

History

Updated by stomar (Marcus Stollsteimer) over 4 years ago

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

Updated by stomar (Marcus Stollsteimer) over 4 years ago

zzak (Zachary Scott) 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 4 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.
#4

Updated by usa (Usaku NAKAMURA) over 4 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 4 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 4 years ago

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

Also available in: Atom PDF