[前][次][番号順一覧][スレッド一覧]

ruby-changes:45698

From: stomar <ko1@a...>
Date: Sat, 4 Mar 2017 22:13:53 +0900 (JST)
Subject: [ruby-changes:45698] stomar:r57771 (trunk): documentation for sort methods

stomar	2017-03-04 22:13:50 +0900 (Sat, 04 Mar 2017)

  New Revision: 57771

  https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=57771

  Log:
    documentation for sort methods
    
    * array.c: [DOC] fix grammar in Array#sort, #sort!, #sort_by!,
      move references below the code example, add a missing reference.
    * enum.c: [DOC] fix grammar in Enumerable#sort, #sort_by.

  Modified files:
    trunk/array.c
    trunk/enum.c
Index: array.c
===================================================================
--- array.c	(revision 57770)
+++ array.c	(revision 57771)
@@ -2442,14 +2442,14 @@ sort_2(const void *ap, const void *bp, v https://github.com/ruby/ruby/blob/trunk/array.c#L2442
  *  an integer less than 0 when +b+ follows +a+, +0+ when +a+ and +b+
  *  are equivalent, or an integer greater than 0 when +a+ follows +b+.
  *
- *  The result is not guaranteed as stable.  When comparison of two
+ *  The result is not guaranteed to be stable.  When the comparison of two
  *  elements returns +0+, the order of the elements is unpredictable.
  *
- *  See also Enumerable#sort_by.
- *
  *     a = [ "d", "a", "e", "c", "b" ]
  *     a.sort!                    #=> ["a", "b", "c", "d", "e"]
  *     a.sort! { |x,y| y <=> x }  #=> ["e", "d", "c", "b", "a"]
+ *
+ *  See also Enumerable#sort_by.
  */
 
 VALUE
@@ -2526,14 +2526,14 @@ rb_ary_sort_bang(VALUE ary) https://github.com/ruby/ruby/blob/trunk/array.c#L2526
  *  an integer less than 0 when +b+ follows +a+, +0+ when +a+ and +b+
  *  are equivalent, or an integer greater than 0 when +a+ follows +b+.
  *
- *  The result is not guaranteed as stable.  When comparison of two
+ *  The result is not guaranteed to be stable.  When the comparison of two
  *  elements returns +0+, the order of the elements is unpredictable.
  *
- *  See also Enumerable#sort_by.
- *
  *     a = [ "d", "a", "e", "c", "b" ]
  *     a.sort                    #=> ["a", "b", "c", "d", "e"]
  *     a.sort { |x,y| y <=> x }  #=> ["e", "d", "c", "b", "a"]
+ *
+ *  See also Enumerable#sort_by.
  */
 
 VALUE
@@ -2685,11 +2685,12 @@ sort_by_i(RB_BLOCK_CALL_FUNC_ARGLIST(i, https://github.com/ruby/ruby/blob/trunk/array.c#L2685
  *  Sorts +self+ in place using a set of keys generated by mapping the
  *  values in +self+ through the given block.
  *
- *  The result is not guaranteed as stable.  When two keys are equal,
+ *  The result is not guaranteed to be stable.  When two keys are equal,
  *  the order of the corresponding elements is unpredictable.
  *
  *  If no block is given, an Enumerator is returned instead.
  *
+ *  See also Enumerable#sort_by.
  */
 
 static VALUE
Index: enum.c
===================================================================
--- enum.c	(revision 57770)
+++ enum.c	(revision 57771)
@@ -935,7 +935,7 @@ enum_first(int argc, VALUE *argv, VALUE https://github.com/ruby/ruby/blob/trunk/enum.c#L935
  *  an integer less than 0 when +b+ follows +a+, +0+ when +a+ and +b+
  *  are equivalent, or an integer greater than 0 when +a+ follows +b+.
  *
- *  The result is not guaranteed as stable.  When comparison of two
+ *  The result is not guaranteed to be stable.  When the comparison of two
  *  elements returns +0+, the order of the elements is unpredictable.
  *
  *     %w(rhea kea flea).sort           #=> ["flea", "kea", "rhea"]
@@ -1011,7 +1011,7 @@ sort_by_cmp(const void *ap, const void * https://github.com/ruby/ruby/blob/trunk/enum.c#L1011
  *  Sorts <i>enum</i> using a set of keys generated by mapping the
  *  values in <i>enum</i> through the given block.
  *
- *  The result is not guaranteed as stable.  When two keys are equal,
+ *  The result is not guaranteed to be stable.  When two keys are equal,
  *  the order of the corresponding elements is unpredictable.
  *
  *  If no block is given, an enumerator is returned instead.

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]