* 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, 4 insertions, 1 deletions

diff --git a/vm_eval.c b/vm_eval.c
index 9806762d96..7a8fffedb9 100644
--- a/vm_eval.c
+++ b/vm_eval.c
@@ -792,10 +792,13 @@ loop_i(void)
 
 /*
  *  call-seq:
- *     loop {|| block }
+ *     loop { block }
+ *     loop            -> an_enumerator
  *
  *  Repeatedly executes the block.
  *
+ *  If no block is given, an enumerator is returned instead.
+ *
  *     loop do
  *       print "Input: "
  *       line = gets