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 threshold #54602

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from 5 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
6 changes: 6 additions & 0 deletions base/sort.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1569,6 +1569,12 @@ The algorithms used by `DEFAULT_UNSTABLE` are an implementation detail. They are
the same as those used by [`DEFAULT_STABLE`](@ref), but this is subject to change in future.
"""
const DEFAULT_UNSTABLE = DEFAULT_STABLE
"""
DanielFrantes marked this conversation as resolved.
Show resolved Hide resolved
SMALL_THRESHOLD

SMALL_THRESHOLD is constant for internally decide, whatever is arrey considered small or big
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few pointers:

This has spelling errors and is not grammatically correct (in fact I have trouble figuring out what it tries to say).

In addition: this line shouldn't be indented, there should be an empty line before this docstring, and it shouldn't end in an empty line.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I will fix it when I get to the computer

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its better now?


"""
const SMALL_THRESHOLD = 20

function Base.show(io::IO, alg::Algorithm)
Expand Down