Skip to content

Conversation

@udohjeremiah
Copy link
Contributor

Closes the code block for PartialQuickSort which is currently:

"""
    PartialQuickSort{T <: Union{Integer,OrdinalRange}}

Indicate that a sorting function should use the partial quick sort
algorithm. Partial quick sort returns the smallest `k` elements sorted from smallest
to largest, finding them and sorting them using [`QuickSort`](@ref).

Characteristics:
  * *not stable*: does not preserve the ordering of elements which
    compare equal (e.g. "a" and "A" in a sort of letters which
    ignores case).
  * *in-place* in memory.
  * *divide-and-conquer*: sort strategy similar to [`MergeSort`](@ref).

  Note that `PartialQuickSort(k)` does not necessarily sort the whole array. For example,

```jldoctest
julia> x = rand(100);

julia> k = 50:100;

julia> s1 = sort(x; alg=QuickSort);

julia> s2 = sort(x; alg=PartialQuickSort(k));

julia> map(issorted, (s1, s2))
(true, false)

julia> map(x->issorted(x[k]), (s1, s2))
(true, true)

julia> s1[k] == s2[k]
true
"""

There seem to be many mistakes similar to the one pointed out above in many places in the Julia docstrings. I don't know much on Documenter.jl, but isn't this supposed to be an "error", hence not allowing such a docstring to compile?

@giordano
Copy link
Member

giordano commented Mar 7, 2023

There seem to be many mistakes similar to the one pointed out above in many places in the Julia docstrings. I don't know much on Documenter.jl, but isn't this supposed to be an "error", hence not allowing such a docstring to compile?

#48893 (comment) JuliaDocs/Documenter.jl#2059

@LilithHafner LilithHafner added backport 1.9 Change should be backported to release-1.9 docs This change adds or pertains to documentation sorting Put things in order labels Mar 7, 2023
@LilithHafner LilithHafner merged commit a3fe0a8 into JuliaLang:master Mar 7, 2023
KristofferC pushed a commit that referenced this pull request Mar 24, 2023
@KristofferC KristofferC mentioned this pull request Mar 24, 2023
52 tasks
@KristofferC KristofferC removed the backport 1.9 Change should be backported to release-1.9 label Mar 31, 2023
Xnartharax pushed a commit to Xnartharax/julia that referenced this pull request Apr 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs This change adds or pertains to documentation sorting Put things in order

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants