summaryrefslogtreecommitdiffhomepage
path: root/mrblib/enum.rb
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-10-20 12:48:31 -0300
committerSeba Gamboa <[email protected]>2015-10-20 12:48:31 -0300
commit13b552538af9e9794398e4a4177ba1cea04cccca (patch)
treea4c682a8750401876eebc7ede793a6ca1ad70fd5 /mrblib/enum.rb
parentf0e997422137e9fc92923a49465f009b2730e78d (diff)
downloadmruby-13b552538af9e9794398e4a4177ba1cea04cccca.tar.gz
mruby-13b552538af9e9794398e4a4177ba1cea04cccca.zip
Remove obvious warnings from docs
Diffstat (limited to 'mrblib/enum.rb')
-rw-r--r--mrblib/enum.rb19
1 files changed, 9 insertions, 10 deletions
diff --git a/mrblib/enum.rb b/mrblib/enum.rb
index f0c9a4884..650d24302 100644
--- a/mrblib/enum.rb
+++ b/mrblib/enum.rb
@@ -1,17 +1,16 @@
##
# Enumerable
#
-# ISO 15.3.2
+# The <code>Enumerable</code> mixin provides collection classes with
+# several traversal and searching methods, and with the ability to
+# sort. The class must provide a method `each`, which
+# yields successive members of the collection. If
+# {Enumerable#max}, {#min}, or
+# {#sort} is used, the objects in the collection must also
+# implement a meaningful `<=>` operator, as these methods
+# rely on an ordering between members of the collection.
#
-# The <code>Enumerable</code> mixin provides collection classes with
-# several traversal and searching methods, and with the ability to
-# sort. The class must provide a method <code>each</code>, which
-# yields successive members of the collection. If
-# <code>Enumerable#max</code>, <code>#min</code>, or
-# <code>#sort</code> is used, the objects in the collection must also
-# implement a meaningful <code><=></code> operator, as these methods
-# rely on an ordering between members of the collection.
-
+# @ISO 15.3.2
module Enumerable
##