Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docstring for SMALL_ALGORITHM #53807

Merged
merged 5 commits into from
Mar 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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