Misc #15630: Clarification on Comparable documentation

• Status: Closed
• Assignee: -

[shugo (Shugo Maeda)]

The documentation of Comparable#> says:

/*
 *  call-seq:
 *     obj > other    -> true or false
 *
 *  Compares two objects based on the receiver's <code><=></code>
 *  method, returning true if it returns 1.
 */

However, Comparable#> returns if and only if <=> returns any value greater than 0.
It's better to fix the documentation, isn't it?

[shugo (Shugo Maeda)]

• Subject changed from Clarifications on Comparable documentation to Clarification on Comparable documentation

[shugo (Shugo Maeda)]

• Status changed from Open to Closed

Applied in changeset commit:ruby-git|f005ccc771574e8e4e17b7a35c19b352e0b7dc73.

---

Clarify requirements of <=>

A return value of <=> is automatically converted to -1, 0, or 1, so
other values can be returned. [Misc #15630]