[ruby-dev:50015] [Ruby trunk Misc#12835] RDoc comment of String#casecmp

Issue #12835 has been updated by Marcus Stollsteimer.


I tried to clarify this in the rdoc with r57886.

----------------------------------------
Misc #12835: RDoc comment of String#casecmp
https://bugs.ruby-lang.org/issues/12835#change-63468

* Author: Toshihiko Ichida
* Status: Open
* Priority: Normal
* Assignee: 
----------------------------------------
String#casecmp dose not return nil but raise TypError for incomparable argument.

So 

~~~
 *     str.casecmp(other_str)   -> -1, 0, +1 or nil
~~~
should be like

~~~
 *     str.casecmp(other_str)   -> -1, 0, +1
~~~
or

~~~
 *     str.casecmp(other_str)   -> -1, 0, +1 or raise TypeError if other_str is not comparable
~~~


Here is a example.

~~~
irb(main):001:0> "a" <=> 1                               
=> nil                                                   
irb(main):002:0> "a".casecmp(1)                          
TypeError: no implicit conversion of Fixnum into String  

~~~

Japanese Reference Manual has same issue.




-- 
https://bugs.ruby-lang.org/