Skip to content

Commit e0a44ad

Browse files
Lilith HafnerLilith Hafner
authored andcommitted
remove cross references in sorting docs (TODO: Revert this)
1 parent efe23b6 commit e0a44ad

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

stdlib/Sort/docs/src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,10 @@ partialsortperm!
136136

137137
There are currently four sorting algorithms available in base Julia:
138138

139-
* [`InsertionSort`](@ref)
140-
* [`QuickSort`](@ref)
141-
* [`PartialQuickSort(k)`](@ref)
142-
* [`MergeSort`](@ref)
139+
* `InsertionSort`
140+
* `QuickSort`
141+
* `PartialQuickSort(k)`
142+
* `MergeSort`
143143

144144
`InsertionSort` is an O(n^2) stable sorting algorithm. It is efficient for very small `n`, and
145145
is used internally by `QuickSort`.

stdlib/Sort/src/Sort.jl

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ end
5555
issorted(v, lt=isless, by=identity, rev::Bool=false, order::Ordering=Forward)
5656
5757
Test whether a vector is in sorted order. The `lt`, `by` and `rev` keywords modify what
58-
order is considered to be sorted just as they do for [`sort`](@ref).
58+
order is considered to be sorted just as they do for `sort`.
5959
6060
# Examples
6161
```jldoctest
@@ -144,7 +144,7 @@ partialsort!(v::AbstractVector, k::Union{Integer,OrdinalRange};
144144
"""
145145
partialsort(v, k, by=<transform>, lt=<comparison>, rev=false)
146146
147-
Variant of [`partialsort!`](@ref) which copies `v` before partially sorting it, thereby returning the
147+
Variant of `partialsort!` which copies `v` before partially sorting it, thereby returning the
148148
same thing as `partialsort!` but leaving `v` unmodified.
149149
"""
150150
partialsort(v::AbstractVector, k::Union{Integer,OrdinalRange}; kws...) =
@@ -289,7 +289,7 @@ according to the order specified by the `by`, `lt` and `rev` keywords, assuming
289289
is already sorted in that order. Return an empty range located at the insertion point
290290
if `a` does not contain values equal to `x`.
291291
292-
See also: [`insorted`](@ref), [`searchsortedfirst`](@ref), [`sort`](@ref), [`findall`](@ref).
292+
See also: `insorted`, `searchsortedfirst`, `sort`, [`findall`](@ref).
293293
294294
# Examples
295295
```jldoctest
@@ -319,7 +319,7 @@ specified order. Return `lastindex(a) + 1` if `x` is greater than all values in
319319
320320
`insert!`ing `x` at this index will maintain sorted order.
321321
322-
See also: [`searchsortedlast`](@ref), [`searchsorted`](@ref), [`findfirst`](@ref).
322+
See also: `searchsortedlast`, `searchsorted`, [`findfirst`](@ref).
323323
324324
# Examples
325325
```jldoctest
@@ -372,7 +372,7 @@ julia> searchsortedlast([1, 2, 4, 5, 5, 7], 0) # no match, insert at start
372372
Determine whether an item `x` is in the sorted collection `a`, in the sense that
373373
it is [`==`](@ref) to one of the values of the collection according to the order
374374
specified by the `by`, `lt` and `rev` keywords, assuming that `a` is already
375-
sorted in that order, see [`sort`](@ref) for the keywords.
375+
sorted in that order, see `sort` for the keywords.
376376
377377
See also [`in`](@ref).
378378
@@ -430,14 +430,14 @@ end
430430
431431
Indicate that a sorting function should use the partial quick sort
432432
algorithm. Partial quick sort returns the smallest `k` elements sorted from smallest
433-
to largest, finding them and sorting them using [`QuickSort`](@ref).
433+
to largest, finding them and sorting them using `QuickSort`.
434434
435435
Characteristics:
436436
* *not stable*: does not preserve the ordering of elements which
437437
compare equal (e.g. "a" and "A" in a sort of letters which
438438
ignores case).
439439
* *in-place* in memory.
440-
* *divide-and-conquer*: sort strategy similar to [`MergeSort`](@ref).
440+
* *divide-and-conquer*: sort strategy similar to `MergeSort`.
441441
"""
442442
struct PartialQuickSort{T <: Union{Integer,OrdinalRange}} <: Algorithm
443443
k::T
@@ -960,7 +960,7 @@ end
960960
"""
961961
sort(v; alg::Algorithm=defalg(v), lt=isless, by=identity, rev::Bool=false, order::Ordering=Forward)
962962
963-
Variant of [`sort!`](@ref) that returns a sorted copy of `v` leaving `v` itself unmodified.
963+
Variant of `sort!` that returns a sorted copy of `v` leaving `v` itself unmodified.
964964
965965
# Examples
966966
```jldoctest
@@ -1020,7 +1020,7 @@ partialsortperm(v::AbstractVector, k::Union{Integer,OrdinalRange}; kwargs...) =
10201020
"""
10211021
partialsortperm!(ix, v, k; by=<transform>, lt=<comparison>, rev=false, initialized=false)
10221022
1023-
Like [`partialsortperm`](@ref), but accepts a preallocated index vector `ix` the same size as
1023+
Like `partialsortperm`, but accepts a preallocated index vector `ix` the same size as
10241024
`v`, which is used to store (a permutation of) the indices of `v`.
10251025
10261026
If the index vector `ix` is initialized with the indices of `v` (or a permutation thereof), `initialized` should be set to
@@ -1092,11 +1092,11 @@ end
10921092
10931093
Return a permutation vector or array `I` that puts `A[I]` in sorted order along the given dimension.
10941094
If `A` has more than one dimension, then the `dims` keyword argument must be specified. The order is specified
1095-
using the same keywords as [`sort!`](@ref). The permutation is guaranteed to be stable even
1095+
using the same keywords as `sort!`. The permutation is guaranteed to be stable even
10961096
if the sorting algorithm is unstable, meaning that indices of equal elements appear in
10971097
ascending order.
10981098
1099-
See also [`sortperm!`](@ref), [`partialsortperm`](@ref), [`invperm`](@ref), [`indexin`](@ref).
1099+
See also `sortperm!`, `partialsortperm`, [`invperm`](@ref), [`indexin`](@ref).
11001100
To sort slices of an array, refer to [`sortslices`](@ref).
11011101
11021102
# Examples
@@ -1159,7 +1159,7 @@ end
11591159
"""
11601160
sortperm!(ix, A; alg::Algorithm=DEFAULT_UNSTABLE, lt=isless, by=identity, rev::Bool=false, order::Ordering=Forward, initialized::Bool=false, [dims::Integer])
11611161
1162-
Like [`sortperm`](@ref), but accepts a preallocated index vector or array `ix` with the same `axes` as `A`. If `initialized` is `false`
1162+
Like `sortperm`, but accepts a preallocated index vector or array `ix` with the same `axes` as `A`. If `initialized` is `false`
11631163
(the default), `ix` is initialized to contain the values `LinearIndices(A)`.
11641164
11651165
# Examples
@@ -1241,7 +1241,7 @@ end
12411241
sort(A; dims::Integer, alg::Algorithm=DEFAULT_UNSTABLE, lt=isless, by=identity, rev::Bool=false, order::Ordering=Forward)
12421242
12431243
Sort a multidimensional array `A` along the given dimension.
1244-
See [`sort!`](@ref) for a description of possible
1244+
See `sort!` for a description of possible
12451245
keyword arguments.
12461246
12471247
To sort slices of an array, refer to [`sortslices`](@ref).
@@ -1300,7 +1300,7 @@ end
13001300
sort!(A; dims::Integer, alg::Algorithm=defalg(A), lt=isless, by=identity, rev::Bool=false, order::Ordering=Forward)
13011301
13021302
Sort the multidimensional array `A` along dimension `dims`.
1303-
See [`sort!`](@ref) for a description of possible keyword arguments.
1303+
See `sort!` for a description of possible keyword arguments.
13041304
13051305
To sort slices of an array, refer to [`sortslices`](@ref).
13061306

0 commit comments

Comments
 (0)