Bug #13159: [DOC] Revise documentation for OpenStruct

• Status: Closed
• Assignee: -
• Target version: -
• ruby -v: ruby 2.4.0p0 (2016-12-24 revision 57164) [i686-linux]
• Backport: 2.2: DONE, 2.3: DONE, 2.4: DONE

[stomar (Marcus Stollsteimer)]

* update paragraph on implementation:
  define_singleton_method is used, not define_method
* add call-seq with return values for each_pair
* adopt description of dig from Array and Hash
* fix description of the hash method
* :nodoc: initialize_copy, respond_to_missing?
* other small improvements, e.g. use the term `attribute' in the docs
  (instead of `member'), which is clearer for users of the class
* improve code examples: e.g. use more consistent style (always use
  double quotes, drop `p' and `puts', ...), update inspect output,
  use example data that is not prone to change (like population)
* add more code examples
* fix some small errors and grammar

[stomar (Marcus Stollsteimer)]

• File deleted (doc_ostruct.patch)

[stomar (Marcus Stollsteimer)]

• File doc_ostruct.patch doc_ostruct.patch added

Patch updated to reflect r57515 (return value of each_pair).

[stomar (Marcus Stollsteimer)]

• Status changed from Open to Closed

Applied in changeset r57887.

---

lib/ostruct.rb: [DOC] revise docs for OpenStruct

• update paragraph on implementation:
  define_singleton_method is used, not define_method
• add call-seq with return values for each_pair
• adopt description of dig from Array and Hash
• fix description of the hash method
• :nodoc: initialize_copy, respond_to_missing?
• other small improvements, e.g. use the term attribute' in the docs (instead of member'), which is clearer for users of the class
• improve code examples: e.g. use more consistent style (always use
  double quotes, drop p' and puts', ...), update inspect output,
  use example data that is not prone to change (like population)
• add more code examples
• fix some small errors and grammar

[ruby-core:79265] [Bug #13159]

[usa (Usaku NAKAMURA)]

• Backport changed from 2.2: UNKNOWN, 2.3: UNKNOWN, 2.4: UNKNOWN to 2.2: REQUIRED, 2.3: REQUIRED, 2.4: REQUIRED

[usa (Usaku NAKAMURA)]

• Backport changed from 2.2: REQUIRED, 2.3: REQUIRED, 2.4: REQUIRED to 2.2: DONE, 2.3: REQUIRED, 2.4: REQUIRED

ruby_2_2 r58124 merged revision(s) 57887.

[nagachika (Tomoyuki Chikanaga)]

• Backport changed from 2.2: DONE, 2.3: REQUIRED, 2.4: REQUIRED to 2.2: DONE, 2.3: REQUIRED, 2.4: DONE

ruby_2_4 r61364 merged revision(s) 57887.

[usa (Usaku NAKAMURA)]

• Backport changed from 2.2: DONE, 2.3: REQUIRED, 2.4: DONE to 2.2: DONE, 2.3: DONE, 2.4: DONE

ruby_2_3 r62127 merged revision(s) 57887.