From: ayumu.aizawa@...
Date: 2015-01-04T05:53:49+00:00
Subject: [ruby-core:67320] [ruby-trunk - Bug #10125] Array#sort and #sort!	documentation issue

Issue #10125 has been updated by Ayumu AIZAWA.

Related to Bug #9989: Docs give wrong information for sort block return values added

----------------------------------------
Bug #10125: Array#sort and #sort! documentation issue
https://bugs.ruby-lang.org/issues/10125#change-50778

* Author: Maxime R��ty
* Status: Assigned
* Priority: Normal
* Assignee: Zachary Scott
* Category: doc
* Target version: 
* ruby -v: 2.1.2
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN
----------------------------------------
The documentation about the values that should be returned by the block is backwards.

a <=> b will return -1 if a is lower than b, i.e. b follows a (in the sorted array).
a <=> b will return 1 if a is greater than b, i.e. a follows b (in the sorted array).

Using the "follows" verbal form might not be the best choice here, but I'd rather let a native english speaker rephrase it if needed.

This part of the documentation is backwards since the 2.0.0 release (commit 53b61ccb).

Thanks.

---Files--------------------------------
0001-array.c-Fixing-documentation-about-comparisons-in-so.patch (1.25 KB)


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