summaryrefslogtreecommitdiff
path: root/array.c
diff options
context:
space:
mode:
authorBurdetteLamar <[email protected]>2024-10-17 10:01:18 -0500
committerPeter Zhu <[email protected]>2024-10-17 16:54:36 -0400
commitc78e2987d473a44318da024fbcf6cda7647edd70 ()
treef320f65b4fa5c8d5cb283db833376db1052fd323 /array.c
parentb1ffd9e959a4afc88e9303a68988783b4759ad17 (diff)
[DOC] Tweaks for Array#sort!
Notes: Merged: https://.com/ruby/ruby/pull/11908
-rw-r--r--array.c39
1 files changed, 4 insertions, 35 deletions
@@ -3352,43 +3352,12 @@ sort_2(const void *ap, const void *bp, void *dummy)
/*
* call-seq:
- * array.sort! -> self
- * array.sort! {|a, b| ... } -> self
*
- * Returns +self+ with its elements sorted in place.
- *
- * With no block, compares elements using operator <tt>#<=></tt>
- * (see Comparable):
- *
- * a = 'abcde'.split('').shuffle
- * a # => ["e", "b", "d", "a", "c"]
- * a.sort!
- * a # => ["a", "b", "c", "d", "e"]
- *
- * With a block, calls the block with each element pair;
- * for each element pair +a+ and +b+, the block should return an integer:
- *
- * - Negative when +b+ is to follow +a+.
- * - Zero when +a+ and +b+ are equivalent.
- * - Positive when +a+ is to follow +b+.
- *
- * Example:
- *
- * a = 'abcde'.split('').shuffle
- * a # => ["e", "b", "d", "a", "c"]
- * a.sort! {|a, b| a <=> b }
- * a # => ["a", "b", "c", "d", "e"]
- * a.sort! {|a, b| b <=> a }
- * a # => ["e", "d", "c", "b", "a"]
- *
- * When the block returns zero, the order for +a+ and +b+ is indeterminate,
- * and may be unstable:
- *
- * a = 'abcde'.split('').shuffle
- * a # => ["e", "b", "d", "a", "c"]
- * a.sort! {|a, b| 0 }
- * a # => ["d", "e", "c", "a", "b"]
*
*/
VALUE