1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

[DOC] Improve readability of requirements for <=>

This commit is contained in:
Marcus Stollsteimer 2019-12-23 15:02:59 +01:00
parent 9a42e0c7ed
commit 16fddfe352

View file

@ -253,9 +253,9 @@ cmp_clamp(int argc, VALUE *argv, VALUE x)
/*
* The Comparable mixin is used by classes whose objects may be
* ordered. The class must define the <code><=></code> operator,
* which compares the receiver against another object, returning
* a value less than 0, 0, or a value greater than 0, depending on
* whether the receiver is less than, equal to,
* which compares the receiver against another object, returning a
* value less than 0, returning 0, or returning a value greater than 0,
* depending on whether the receiver is less than, equal to,
* or greater than the other object. If the other object is not
* comparable then the <code><=></code> operator should return +nil+.
* Comparable uses <code><=></code> to implement the conventional