Improve rdoc for Enumerator#next. Remove a not-so-notable note.

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

1 files changed, 4 insertions, 8 deletions

diff --git a/lib/generator.rb b/lib/generator.rb
index 2f4ceaa013..8285c0c33e 100644
--- a/lib/generator.rb
+++ b/lib/generator.rb
@@ -178,16 +178,12 @@ class Enumerator
   #   e.next   => object
   #
   # Returns the next object in the enumerator, and move the internal
-  # position forward.  When the position reached at the end, internal
+  # position forward.  When the position reaches at the end, internal
   # position is rewound then StopIteration is raised.
   #
-  # Note that enumeration sequence by next method does not affect other
-  # non-external enumeration methods, unless underlying iteration
-  # methods itself has side-effect, e.g. IO#each_line.
-  #
-  # Caution: This feature internally uses Generator, which uses callcc
-  # to stop and resume enumeration to fetch each value.  Use with care
-  # and be aware of the performance loss.
+  # Caution: This method is slow.  It is implemented using the
+  # Generator library which uses callcc to stop and resume an "each"
+  # method to fetch values one by one.
   def next
     g = __generator
     return g.next unless g.end?