Are the docs correct for spaceship <=> in String?

  • Thread starter thomas.c.mitchell
  • Start date
T

thomas.c.mitchell

Hello all,

First-time poster.. I apologize if I am posting to the wrong group.

I am teaching a class of high-schoolers in programming, using Ruby. I
gave them an exercise called "Stupid String Tricks" which was about
getting them comfortable using the online documentation for Ruby. The
assignment was to do five silly things with Strings and share their
results with the class.

While walking through the docs online during class, we decided to dig
into <=> and demonstrate how it works and how to interpret the docs.
We used this page:

http://www.ruby-doc.org/core/classes/String.html#M000778

I thought that page was the authoritative one.

I believe the operator/method behaves correctly, but believe the doc
is not correct.

<quote>

str <=> other_str => -1, 0, +1

Comparison—Returns -1 if other_str is less than, 0 if other_str is
equal to, and +1 if other_str is greater than str.

</quote>

Isn't it the other way around? Shouldn't the return be -1 if str is
less than other_str? The class behavior and the examples in the docs
all behave that way.

If this is not the right place to get visibility for this, what is?

Thanks in advance.
 
L

Louis-Philippe

whats funny, is that the text of the documentation is wrong while the
examples are showing the right behaviour.
I'm sure somebody on this list as autoritative power on this doc!
 
G

Gregory Brown

whats funny, is that the text of the documentation is wrong while the
examples are showing the right behaviour.
I'm sure somebody on this list as autoritative power on this doc!

You can subscribe and post to ruby-core, and/or file a ticket in Ruby's tracker:
http://redmine.ruby-lang.org/

-greg
 
E

Eustáquio Rangel

whats funny, is that the text of the documentation is wrong while the
Ouch. Glad to know that the behaviour is right, only the docs are
wrong. I was wondering if some code I made with that was running ok.
:)
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

No members online now.

Forum statistics

Threads
473,744
Messages
2,569,484
Members
44,903
Latest member
orderPeak8CBDGummies

Latest Threads

Top