* array.c: Harmonize documentation, in particular regarding:

    - methods returning enumerators
    - array methods and argument naming (array -> ary, an_array -> new_ary)
    - minor improvements, typo fixed and styling issues

  Other documentation errors fixed:
    - return value was self instead of a new array (or vice-versa) for
      Array#{pop,shift,permutation,repeated_permutation,keep_if}
    - Array#rindex was missing the form with a block.

* dir.c: ditto.

* enum.c: ditto. Modified Enumerable#reverse_each' documentation to clarify
  that #each will be finish before any element is yielded.

* error.c: ditto.

* gc.c: ditto.

* hash.c: ditto.

* io.c: ditto. IO#{codepoints,each_codepoint} fixed as per [ruby-core:23948]

* numeric.c: ditto.

* range.c: ditto.

* string.c: ditto.

* struct.c: ditto.

* vm_eval.c: ditto.

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

1 files changed, 3 insertions, 0 deletions

diff --git a/gc.c b/gc.c
index b88450d0e6..3698db6424 100644
--- a/gc.c
+++ b/gc.c
@@ -2424,6 +2424,7 @@ os_obj_of(VALUE of)
 /*
  *  call-seq:
  *     ObjectSpace.each_object([module]) {|obj| ... } => fixnum
+ *     ObjectSpace.each_object([module])              => an_enumerator
  *
  *  Calls the block once for each living, nonimmediate object in this
  *  Ruby process. If <i>module</i> is specified, calls the block
@@ -2435,6 +2436,8 @@ os_obj_of(VALUE of)
  *  returns both the numbers we defined and several constants defined in
  *  the <code>Math</code> module.
  *
+ *  If no block is given, an enumerator is returned instead.
+ *
  *     a = 102.7
  *     b = 95       # Won't be returned
  *     c = 12345678987654321