aboutsummaryrefslogtreecommitdiffstats
path: root/object.c
diff options
context:
space:
mode:
authoreregon <eregon@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-12-28 13:22:42 +0000
committereregon <eregon@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-12-28 13:22:42 +0000
commit58a60b264deecf33a32c52fbe4a6605263ed3250 (patch)
tree5e4a70b5833a859895d2f76cf294109824088435 /object.c
parent75f4731f900f3cee32c38da5d7c919ff5bb6d873 (diff)
downloadruby-58a60b264deecf33a32c52fbe4a6605263ed3250.tar.gz
* object.c (Kernel#<=>) surround Comparable operators with <code> tags.
The #== method was hidden in ri/rdoc's output and was highlighting the line instead. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@44452 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r--object.c8
1 files changed, 4 insertions, 4 deletions
diff --git a/object.c b/object.c
index 466ec75492..e54285d8fc 100644
--- a/object.c
+++ b/object.c
@@ -1403,16 +1403,16 @@ rb_obj_not_match(VALUE obj1, VALUE obj2)
* Returns 0 if +obj+ and +other+ are the same object
* or <code>obj == other</code>, otherwise nil.
*
- * The <=> is used by various methods to compare objects, for example
+ * The <code><=></code> is used by various methods to compare objects, for example
* Enumerable#sort, Enumerable#max etc.
*
- * Your implementation of <=> should return one of the following values: -1, 0,
+ * Your implementation of <code><=></code> should return one of the following values: -1, 0,
* 1 or nil. -1 means self is smaller than other. 0 means self is equal to other.
* 1 means self is bigger than other. Nil means the two values could not be
* compared.
*
- * When you define <=>, you can include Comparable to gain the methods <=, <,
- * ==, >=, > and between?.
+ * When you define <code><=></code>, you can include Comparable to gain the methods
+ * <code><=</code>, <code><</code>, <code>==</code>, <code>>=</code>, <code>></code> and <code>between?</code>.
*/
static VALUE
rb_obj_cmp(VALUE obj1, VALUE obj2)