[ruby-core:66368] [ruby-trunk - Bug #10526] [Open] [DOC] Revise documentation in object.c

[ruby-core:66368] [ruby-trunk - Bug #10526] [Open] [DOC] Revise documentation in object.c

[sto.mar]

Issue #10526 has been reported by Marcus Stollsteimer.

----------------------------------------
Bug #10526: [DOC] Revise documentation in object.c
https://bugs.ruby-lang.org/issues/10526

* Author: Marcus Stollsteimer
* Status: Open
* Priority: Normal
* Assignee: Zachary Scott
* Category: doc
* Target version: 
* ruby -v: ruby 2.1.4p265 (2014-10-27 revision 48166) [i686-linux]
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN
----------------------------------------
* #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)


-- 
https://bugs.ruby-lang.org/

[ruby-core:66399] [ruby-trunk - Bug #10526] [DOC] Revise documentation in object.c

[sto.mar]

Issue #10526 has been updated by Marcus Stollsteimer.

File 10526_doc_object_c.patch_new added

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

----------------------------------------
Bug #10526: [DOC] Revise documentation in object.c
https://bugs.ruby-lang.org/issues/10526#change-50039

* Author: Marcus Stollsteimer
* Status: Open
* Priority: Normal
* Assignee: Zachary Scott
* Category: doc
* Target version: 
* ruby -v: ruby 2.1.4p265 (2014-10-27 revision 48166) [i686-linux]
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN
----------------------------------------
* #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)
10526_doc_object_c.patch_new (16.7 KB)


-- 
https://bugs.ruby-lang.org/

[ruby-core:66647] [ruby-trunk - Bug #10526] [DOC] Revise documentation in object.c

[sto.mar]

Issue #10526 has been updated by Marcus Stollsteimer.


@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?

----------------------------------------
Bug #10526: [DOC] Revise documentation in object.c
https://bugs.ruby-lang.org/issues/10526#change-50258

* Author: Marcus Stollsteimer
* Status: Open
* Priority: Normal
* Assignee: Zachary Scott
* Category: doc
* Target version: 
* ruby -v: ruby 2.1.4p265 (2014-10-27 revision 48166) [i686-linux]
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN
----------------------------------------
* #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)
10526_doc_object_c.patch_new (16.7 KB)


-- 
https://bugs.ruby-lang.org/

[ruby-core:66757] [ruby-trunk - Bug #10526] [Closed] [DOC] Revise documentation in object.c

[nobu]

Issue #10526 has been updated by Nobuyoshi Nakada.

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.

----------------------------------------
Bug #10526: [DOC] Revise documentation in object.c
https://bugs.ruby-lang.org/issues/10526#change-50344

* Author: Marcus Stollsteimer
* Status: Closed
* Priority: Normal
* Assignee: Zachary Scott
* Category: doc
* Target version: 
* ruby -v: ruby 2.1.4p265 (2014-10-27 revision 48166) [i686-linux]
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN
----------------------------------------
* #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)
10526_doc_object_c.patch_new (16.7 KB)


-- 
https://bugs.ruby-lang.org/

[ruby-core:67726] [ruby-trunk - Bug #10526] [DOC] Revise documentation in object.c

[nagachika00]

Issue #10526 has been updated by Tomoyuki Chikanaga.

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.


----------------------------------------
Bug #10526: [DOC] Revise documentation in object.c
https://bugs.ruby-lang.org/issues/10526#change-51154

* Author: Marcus Stollsteimer
* Status: Closed
* Priority: Normal
* Assignee: Zachary Scott
* ruby -v: ruby 2.1.4p265 (2014-10-27 revision 48166) [i686-linux]
* Backport: 2.0.0: REQUIRED, 2.1: DONE
----------------------------------------
* #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)
10526_doc_object_c.patch_new (16.7 KB)


-- 
https://bugs.ruby-lang.org/

[ruby-core:68299] [Ruby trunk - Bug #10526] [DOC] Revise documentation in object.c

[usa]

Issue #10526 has been updated by Usaku NAKAMURA.

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

----------------------------------------
Bug #10526: [DOC] Revise documentation in object.c
https://bugs.ruby-lang.org/issues/10526#change-51652

* Author: Marcus Stollsteimer
* Status: Closed
* Priority: Normal
* Assignee: Zachary Scott
* ruby -v: ruby 2.1.4p265 (2014-10-27 revision 48166) [i686-linux]
* Backport: 2.0.0: DONE, 2.1: DONE
----------------------------------------
* #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)
10526_doc_object_c.patch_new (16.7 KB)


-- 
https://bugs.ruby-lang.org/