Skip to content
Browse files

Add documentation to Comparable

  • Loading branch information...
1 parent f6d539e commit c1faad90ec8768b9364638da4bb56b47b87c6661 @bovi bovi committed May 27, 2012
Showing with 44 additions and 8 deletions.
  1. +44 −8 mrblib/compar.rb
View
52 mrblib/compar.rb
@@ -1,5 +1,15 @@
+##
+# Comparable
+#
+# ISO 15.3.3
module Comparable
- # 15.3.3.2.1
+
+ ##
+ # Return true if +self+ is less
+ # than +other+. Otherwise return
+ # false.
+ #
+ # ISO 15.3.3.2.1
def < other
cmp = self <=> other
if cmp.nil?
@@ -11,7 +21,12 @@ def < other
end
end
- # 15.3.3.2.2
+ ##
+ # Return true if +self+ is less
+ # than or equal to +other+.
+ # Otherwise return false.
+ #
+ # ISO 15.3.3.2.2
def <= other
cmp = self <=> other
if cmp.nil?
@@ -23,7 +38,12 @@ def <= other
end
end
- # 15.3.3.2.3
+ ##
+ # Return true if +self+ is equal
+ # to +other+. Otherwise return
+ # false.
+ #
+ # ISO 15.3.3.2.3
def == other
cmp = self <=> other
if cmp == 0
@@ -33,7 +53,12 @@ def == other
end
end
- # 15.3.3.2.4
+ ##
+ # Return true if +self+ is greater
+ # than +other+. Otherwise return
+ # false.
+ #
+ # ISO 15.3.3.2.4
def > other
cmp = self <=> other
if cmp.nil?
@@ -45,9 +70,14 @@ def > other
end
end
- # 15.3.3.2.5
+ ##
+ # Return true if +self+ is greater
+ # than or equal to +other+.
+ # Otherwise return false.
+ #
+ # ISO 15.3.3.2.5
def >= other
- cmp = self <=> other
+ cmp = self <=> other
if cmp.nil?
false
elsif cmp >= 0
@@ -57,8 +87,14 @@ def >= other
end
end
- # 15.3.3.2.6
- def between?(min,max)
+ ##
+ # Return true if +self+ is greater
+ # than or equal to +min+ and
+ # less than or equal to +max+.
+ # Otherwise return false.
+ #
+ # ISO 15.3.3.2.6
+ def between?(min, max)
if self < min or self > max
false
else

0 comments on commit c1faad9

Please sign in to comment.
Something went wrong with that request. Please try again.