Skip to content

Commit

Permalink
Add docstring for Base.Sort.SMALL_ALGORITHM (#53807)
Browse files Browse the repository at this point in the history
Co-authored-by: Lilith Orion Hafner <lilithhafner@gmail.com>
Co-authored-by: Steven G. Johnson <stevenj@mit.edu>
  • Loading branch information
3 people authored Mar 23, 2024
1 parent 63e365f commit 243f67d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions base/sort.jl
Original file line number Diff line number Diff line change
Expand Up @@ -812,6 +812,16 @@ Characteristics:
it is well-suited to small collections but should not be used for large ones.
"""
const InsertionSort = InsertionSortAlg()

"""
SMALL_ALGORITHM
Default sorting algorithm for small arrays.
This is an alias for a simple low-overhead algorithm that does not scale well
to large arrays, unlike high-overhead recursive algorithms used for larger arrays.
`SMALL_ALGORITHM` is a good choice for the base case of a recursive algorithm.
"""
const SMALL_ALGORITHM = InsertionSortAlg()

function _sort!(v::AbstractVector, ::InsertionSortAlg, o::Ordering, kw)
Expand Down
2 changes: 1 addition & 1 deletion test/sorting.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ using .Main.OffsetArrays
@testset "Base.Sort docstrings" begin
undoc = Docs.undocumented_names(Base.Sort)
@test_broken isempty(undoc)
@test undoc == [:Algorithm, :SMALL_ALGORITHM, :SMALL_THRESHOLD, :Sort]
@test undoc == [:Algorithm, :SMALL_THRESHOLD, :Sort]
end

@testset "Order" begin
Expand Down

0 comments on commit 243f67d

Please sign in to comment.