* enum.c (group_by): Improve documentation based on patch by b t.

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

2 files changed, 9 insertions, 5 deletions

diff --git a/ChangeLog b/ChangeLog
index 5b6e2d0f82..4ae6fad905 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,7 +1,11 @@
+Thu Oct  6 10:00:54 2011  Eric Hodel  <drbrain@segment7.net>
+
+	* enum.c (group_by):  Improve documentation based on patch by b t.
+
 Thu Oct  6 09:56:30 2011  Eric Hodel  <drbrain@segment7.net>
 
 	* enum.c:  Clean up wording in Enumerable documentation.  Patch by b t.
-	  [Ruby 1.9 - Bug #5411
+	  [Ruby 1.9 - Bug #5411]
 
 Thu Oct  6 09:17:18 2011  Eric Hodel  <drbrain@segment7.net>
 
diff --git a/enum.c b/enum.c
index 3120b066da..7a94ef658f 100644
--- a/enum.c
+++ b/enum.c
@@ -657,11 +657,11 @@ group_by_i(VALUE i, VALUE hash, int argc, VALUE *argv)
  *     enum.group_by {| obj | block }  -> a_hash
  *     enum.group_by                   -> an_enumerator
  *
- *  Returns a hash, which keys are evaluated result from the
- *  block, and values are arrays of elements in <i>enum</i>
- *  corresponding to the key.
+ *  Groups the collection by result of the block.  Returns a hash where the
+ *  keys are the evaluated result from the block and values the values are
+ *  arrays of elements in the collection that corresponding to the key.
  *
- *  If no block is given, an enumerator is returned instead.
+ *  If no block is given an enumerator is returned.
  *
  *     (1..6).group_by {|i| i%3}   #=> {0=>[3, 6], 1=>[1, 4], 2=>[2, 5]}
  *