Skip to content

Commit 071d0ec

Browse files
BurdetteLamarpeterzhu2118
authored andcommitted
[DOC] Sort items in What's Here
1 parent 25d1786 commit 071d0ec

File tree

1 file changed

+47
-69
lines changed

1 file changed

+47
-69
lines changed

array.c

Lines changed: 47 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -8560,136 +8560,115 @@ rb_ary_deconstruct(VALUE ary)
85608560
*
85618561
* === Methods for Querying
85628562
*
8563-
* - #length (aliased as #size): Returns the count of elements.
8564-
* - #include?: Returns whether any element <tt>==</tt> a given object.
8565-
* - #empty?: Returns whether there are no elements.
85668563
* - #all?: Returns whether all elements meet a given criterion.
85678564
* - #any?: Returns whether any element meets a given criterion.
8568-
* - #none?: Returns whether no element <tt>==</tt> a given object.
8569-
* - #one?: Returns whether exactly one element <tt>==</tt> a given object.
85708565
* - #count: Returns the count of elements that meet a given criterion.
8566+
* - #empty?: Returns whether there are no elements.
85718567
* - #find_index (aliased as #index): Returns the index of the first element that meets a given criterion.
8572-
* - #rindex: Returns the index of the last element that meets a given criterion.
85738568
* - #hash: Returns the integer hash code.
8569+
* - #include?: Returns whether any element <tt>==</tt> a given object.
8570+
* - #length (aliased as #size): Returns the count of elements.
8571+
* - #none?: Returns whether no element <tt>==</tt> a given object.
8572+
* - #one?: Returns whether exactly one element <tt>==</tt> a given object.
8573+
* - #rindex: Returns the index of the last element that meets a given criterion.
85748574
*
85758575
* === Methods for Comparing
85768576
*
8577-
* - #<=>: Returns -1, 0, or 1, as +self+ is less than, equal to, or
8578-
* greater than a given object.
8579-
* - #==: Returns whether each element in +self+ is <tt>==</tt> to the corresponding element
8580-
* in a given object.
8581-
* - #eql?: Returns whether each element in +self+ is <tt>eql?</tt> to the corresponding
8582-
* element in a given object.
8577+
* - #<=>: Returns -1, 0, or 1, as +self+ is less than, equal to, or greater than a given object.
8578+
* - #==: Returns whether each element in +self+ is <tt>==</tt> to the corresponding element in a given object.
8579+
* - #eql?: Returns whether each element in +self+ is <tt>eql?</tt> to the corresponding element in a given object.
85838580
85848581
* === Methods for Fetching
85858582
*
85868583
* These methods do not modify +self+.
85878584
*
85888585
* - #[] (aliased as #slice): Returns consecutive elements as determined by a given argument.
8586+
* - #assoc: Returns the first element that is an array whose first element <tt>==</tt> a given object.
8587+
* - #at: Returns the element at a given offset.
8588+
* - #bsearch: Returns an element selected via a binary search as determined by a given block.
8589+
* - #bsearch_index: Returns the index of an element selected via a binary search as determined by a given block.
8590+
* - #compact: Returns an array containing all non-+nil+ elements.
8591+
* - #dig: Returns the object in nested objects that is specified by a given index and additional arguments.
8592+
* - #drop: Returns trailing elements as determined by a given index.
8593+
* - #drop_while: Returns trailing elements as determined by a given block.
85898594
* - #fetch: Returns the element at a given offset.
85908595
* - #fetch_values: Returns elements at given offsets.
85918596
* - #first: Returns one or more leading elements.
85928597
* - #last: Returns one or more trailing elements.
8593-
* - #max: Returns one or more maximum-valued elements,
8594-
* as determined by <tt>#<=></tt> or a given block.
8595-
* - #min: Returns one or more minimum-valued elements,
8596-
* as determined by <tt>#<=></tt> or a given block.
8597-
* - #minmax: Returns the minimum-valued and maximum-valued elements,
8598-
* as determined by <tt>#<=></tt> or a given block.
8599-
* - #assoc: Returns the first element that is an array
8600-
* whose first element <tt>==</tt> a given object.
8601-
* - #rassoc: Returns the first element that is an array
8602-
* whose second element <tt>==</tt> a given object.
8603-
* - #at: Returns the element at a given offset.
8604-
* - #values_at: Returns the elements at given offsets.
8605-
* - #dig: Returns the object in nested objects
8606-
* that is specified by a given index and additional arguments.
8607-
* - #drop: Returns trailing elements as determined by a given index.
8608-
* - #take: Returns leading elements as determined by a given index.
8609-
* - #drop_while: Returns trailing elements as determined by a given block.
8610-
* - #take_while: Returns leading elements as determined by a given block.
8611-
* - #sort: Returns all elements in an order determined by <tt>#<=></tt> or a given block.
8598+
* - #max: Returns one or more maximum-valued elements, as determined by <tt>#<=></tt> or a given block.
8599+
* - #min: Returns one or more minimum-valued elements, as determined by <tt>#<=></tt> or a given block.
8600+
* - #minmax: Returns the minimum-valued and maximum-valued elements, as determined by <tt>#<=></tt> or a given block.
8601+
* - #rassoc: Returns the first element that is an array whose second element <tt>==</tt> a given object.
8602+
* - #reject: Returns an array containing elements not rejected by a given block.
86128603
* - #reverse: Returns all elements in reverse order.
8613-
* - #compact: Returns an array containing all non-+nil+ elements.
8614-
* - #select (aliased as #filter): Returns an array containing elements selected by a given block.
8615-
* - #uniq: Returns an array containing non-duplicate elements.
86168604
* - #rotate: Returns all elements with some rotated from one end to the other.
8617-
* - #bsearch: Returns an element selected via a binary search
8618-
* as determined by a given block.
8619-
* - #bsearch_index: Returns the index of an element selected via a binary search
8620-
* as determined by a given block.
86218605
* - #sample: Returns one or more random elements.
8606+
* - #select (aliased as #filter): Returns an array containing elements selected by a given block.
86228607
* - #shuffle: Returns elements in a random order.
8623-
* - #reject: Returns an array containing elements not rejected by a given block.
8608+
* - #sort: Returns all elements in an order determined by <tt>#<=></tt> or a given block.
8609+
* - #take: Returns leading elements as determined by a given index.
8610+
* - #take_while: Returns leading elements as determined by a given block.
8611+
* - #uniq: Returns an array containing non-duplicate elements.
8612+
* - #values_at: Returns the elements at given offsets.
86248613
*
86258614
* === Methods for Assigning
86268615
*
86278616
* These methods add, replace, or reorder elements in +self+.
86288617
*
8629-
* - #[]=: Assigns specified elements with a given object.
86308618
* - #<<: Appends an element.
8631-
* - #push (aliased as #append): Appends elements.
8632-
* - #unshift (aliased as #prepend): Prepends leading elements.
8633-
* - #insert: Inserts given objects at a given offset; does not replace elements.
8619+
* - #[]=: Assigns specified elements with a given object.
86348620
* - #concat: Appends all elements from given arrays.
86358621
* - #fill: Replaces specified elements with specified objects.
86368622
* - #flatten!: Replaces each nested array in +self+ with the elements from that array.
86378623
* - #initialize_copy (aliased as #replace): Replaces the content of +self+ with the content of a given array.
8624+
* - #insert: Inserts given objects at a given offset; does not replace elements.
8625+
* - #push (aliased as #append): Appends elements.
86388626
* - #reverse!: Replaces +self+ with its elements reversed.
86398627
* - #rotate!: Replaces +self+ with its elements rotated.
86408628
* - #shuffle!: Replaces +self+ with its elements in random order.
8641-
* - #sort!: Replaces +self+ with its elements sorted,
8642-
* as determined by <tt>#<=></tt> or a given block.
8629+
* - #sort!: Replaces +self+ with its elements sorted, as determined by <tt>#<=></tt> or a given block.
86438630
* - #sort_by!: Replaces +self+ with its elements sorted, as determined by a given block.
8631+
* - #unshift (aliased as #prepend): Prepends leading elements.
86448632
*
86458633
* === Methods for Deleting
86468634
*
86478635
* Each of these methods removes elements from +self+:
86488636
*
8649-
* - #pop: Removes and returns the last element.
8650-
* - #shift: Removes and returns the first element.
8637+
* - #clear: Removes all elements.
86518638
* - #compact!: Removes all +nil+ elements.
86528639
* - #delete: Removes elements equal to a given object.
86538640
* - #delete_at: Removes the element at a given offset.
86548641
* - #delete_if: Removes elements specified by a given block.
8655-
* - #clear: Removes all elements.
86568642
* - #keep_if: Removes elements not specified by a given block.
8643+
* - #pop: Removes and returns the last element.
86578644
* - #reject!: Removes elements specified by a given block.
86588645
* - #select! (aliased as #filter!): Removes elements not specified by a given block.
8646+
* - #shift: Removes and returns the first element.
86598647
* - #slice!: Removes and returns a sequence of elements.
86608648
* - #uniq!: Removes duplicates.
86618649
*
86628650
* === Methods for Combining
86638651
*
86648652
* - #&: Returns an array containing elements found both in +self+ and a given array.
8665-
* - #intersection: Returns an array containing elements found both in +self+
8666-
* and in each given array.
86678653
* - #+: Returns an array containing all elements of +self+ followed by all elements of a given array.
86688654
* - #-: Returns an array containing all elements of +self+ that are not found in a given array.
8669-
* - #|: Returns an array containing all elements of +self+ and all elements of a given array,
8670-
* duplicates removed.
8671-
* - #union: Returns an array containing all elements of +self+ and all elements of given arrays,
8672-
* duplicates removed.
8673-
* - #difference: Returns an array containing all elements of +self+ that are not found
8674-
* in any of the given arrays..
8655+
* - #difference: Returns an array containing all elements of +self+ that are not found in any of the given arrays..
8656+
* - #intersection: Returns an array containing elements found both in +self+ and in each given array.
86758657
* - #product: Returns or yields all combinations of elements from +self+ and given arrays.
86768658
* - #reverse: Returns an array containing all elements of +self+ in reverse order.
8659+
* - #union: Returns an array containing all elements of +self+ and all elements of given arrays, duplicates removed.
8660+
* - #|: Returns an array containing all elements of +self+ and all elements of a given array, duplicates removed.
86778661
*
86788662
* === Methods for Iterating
86798663
*
8664+
* - #combination: Calls a given block with combinations of elements of +self+; a combination does not use the same element more than once.
8665+
* - #cycle: Calls a given block with each element, then does so again, for a specified number of times, or forever.
86808666
* - #each: Passes each element to a given block.
8681-
* - #reverse_each: Passes each element, in reverse order, to a given block.
86828667
* - #each_index: Passes each element index to a given block.
8683-
* - #cycle: Calls a given block with each element, then does so again,
8684-
* for a specified number of times, or forever.
8685-
* - #combination: Calls a given block with combinations of elements of +self+;
8686-
* a combination does not use the same element more than once.
8687-
* - #permutation: Calls a given block with permutations of elements of +self+;
8688-
* a permutation does not use the same element more than once.
8689-
* - #repeated_combination: Calls a given block with combinations of elements of +self+;
8690-
* a combination may use the same element more than once.
8691-
* - #repeated_permutation: Calls a given block with permutations of elements of +self+;
8692-
* a permutation may use the same element more than once.
8668+
* - #permutation: Calls a given block with permutations of elements of +self+; a permutation does not use the same element more than once.
8669+
* - #repeated_combination: Calls a given block with combinations of elements of +self+; a combination may use the same element more than once.
8670+
* - #repeated_permutation: Calls a given block with permutations of elements of +self+; a permutation may use the same element more than once.
8671+
* - #reverse_each: Passes each element, in reverse order, to a given block.
86938672
*
86948673
* === Methods for Converting
86958674
*
@@ -8702,8 +8681,7 @@ rb_ary_deconstruct(VALUE ary)
87028681
* - #to_ary: Returns +self+.
87038682
* - #to_h: Returns a new hash formed from the elements.
87048683
* - #transpose: Transposes +self+, which must be an array of arrays.
8705-
* - #zip: Returns a new array of arrays containing +self+ and given arrays;
8706-
* follow the link for details.
8684+
* - #zip: Returns a new array of arrays containing +self+ and given arrays.
87078685
*
87088686
* === Other Methods
87098687
*

0 commit comments

Comments
 (0)