Skip to content

Commit f0f4a68

Browse files
committed
[DOC] Improve docs for Module#<=
1 parent 0b83346 commit f0f4a68

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

object.c

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1915,11 +1915,24 @@ rb_mod_eqq(VALUE mod, VALUE arg)
19151915
* call-seq:
19161916
* mod <= other -> true, false, or nil
19171917
*
1918-
* Returns true if <i>mod</i> is a subclass of <i>other</i> or
1919-
* is the same as <i>other</i>. Returns
1920-
* <code>nil</code> if there's no relationship between the two.
1921-
* (Think of the relationship in terms of the class definition:
1922-
* "class A < B" implies "A < B".)
1918+
* Returns +true+ if +self+ is a descendant of +other+
1919+
* (+self+ is a subclass of +other+ or +self+ includes +other+) or
1920+
* if +self+ is the same as +other+:
1921+
*
1922+
* Float <= Numeric # => true
1923+
* Array <= Enumerable # => true
1924+
* Float <= Float # => true
1925+
*
1926+
* Returns +false+ if +self+ is an ancestor of +other+
1927+
* (+self+ is a superclass of +other+ or +self+ is included in +other+):
1928+
*
1929+
* Numeric <= Float # => false
1930+
* Enumerable <= Array # => false
1931+
*
1932+
* Returns +nil+ if there is no relationship between the two:
1933+
*
1934+
* Float <= Hash # => nil
1935+
* Enumerable <= String # => nil
19231936
*/
19241937

19251938
VALUE

0 commit comments

Comments
 (0)