summaryrefslogtreecommitdiffhomepage
path: root/mrblib/enum.rb
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2015-10-22 07:10:16 +0900
committerYukihiro "Matz" Matsumoto <[email protected]>2015-10-22 07:10:16 +0900
commit727f2485c9028cbd5eb4085e965bcaada6fb53f6 (patch)
treeb6876bcd35017746de47dc5f3949fcb72ea37c16 /mrblib/enum.rb
parente5fbf9dfa2bbbe5ecbf6cc25ff5d35e7da7f00e3 (diff)
parentd4238494eb7cd36c510c87ace6c31aeb1d0f1d6b (diff)
downloadmruby-727f2485c9028cbd5eb4085e965bcaada6fb53f6.tar.gz
mruby-727f2485c9028cbd5eb4085e965bcaada6fb53f6.zip
Merge pull request #2999 from sagmor/better-docs
More 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
##