Skip to content

Commit 217c806

Browse files
authored
Upgrade documenter, fix doctests (#21473)
* run NEWS-update.jl #20648 was partially reverted by #20782 * Fix doctest line numbers * Upgrade Documenter, add linkcheck exception bugs.kde.org fails to load from nanosoldier for some reason, gives a CURLE_RECV_ERROR (56) Failure with receiving network data fix alloc.c dead link in devdocs/init.md * fix timeit_init macro in test/perf/perfutil.jl needed to escape its arguments
1 parent 96b28d6 commit 217c806

File tree

9 files changed

+18
-16
lines changed

9 files changed

+18
-16
lines changed

NEWS.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,7 @@ Deprecated or removed
410410
[#12563]: https://github.com/JuliaLang/julia/issues/12563
411411
[#16213]: https://github.com/JuliaLang/julia/issues/16213
412412
[#16961]: https://github.com/JuliaLang/julia/issues/16961
413+
[#16984]: https://github.com/JuliaLang/julia/issues/16984
413414
[#16986]: https://github.com/JuliaLang/julia/issues/16986
414415
[#17057]: https://github.com/JuliaLang/julia/issues/17057
415416
[#17261]: https://github.com/JuliaLang/julia/issues/17261
@@ -450,6 +451,7 @@ Deprecated or removed
450451
[#19469]: https://github.com/JuliaLang/julia/issues/19469
451452
[#19533]: https://github.com/JuliaLang/julia/issues/19533
452453
[#19543]: https://github.com/JuliaLang/julia/issues/19543
454+
[#19594]: https://github.com/JuliaLang/julia/issues/19594
453455
[#19598]: https://github.com/JuliaLang/julia/issues/19598
454456
[#19635]: https://github.com/JuliaLang/julia/issues/19635
455457
[#19670]: https://github.com/JuliaLang/julia/issues/19670
@@ -492,5 +494,4 @@ Deprecated or removed
492494
[#20530]: https://github.com/JuliaLang/julia/issues/20530
493495
[#20543]: https://github.com/JuliaLang/julia/issues/20543
494496
[#20609]: https://github.com/JuliaLang/julia/issues/20609
495-
[#20648]: https://github.com/JuliaLang/julia/issues/20648
496497
[#20889]: https://github.com/JuliaLang/julia/issues/20889

base/array.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -853,8 +853,8 @@ julia> deleteat!([6, 5, 4, 3, 2, 1], [true, false, true, false, true, false])
853853
julia> deleteat!([6, 5, 4, 3, 2, 1], (2, 2))
854854
ERROR: ArgumentError: indices must be unique and sorted
855855
Stacktrace:
856-
[1] _deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:862
857-
[2] deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:849
856+
[1] _deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:873
857+
[2] deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:860
858858
```
859859
"""
860860
deleteat!(a::Vector, inds) = _deleteat!(a, inds)

base/docs/helpdb/Base.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -1945,7 +1945,7 @@ julia> convert(Int, 3.0)
19451945
julia> convert(Int, 3.5)
19461946
ERROR: InexactError()
19471947
Stacktrace:
1948-
[1] convert(::Type{Int64}, ::Float64) at ./float.jl:675
1948+
[1] convert(::Type{Int64}, ::Float64) at ./float.jl:679
19491949
```
19501950
19511951
If `T` is a `AbstractFloat` or `Rational` type,

doc/REQUIRE

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Compat 0.21.0 0.21.0+
2-
DocStringExtensions 0.3.2 0.3.2+
3-
Documenter 0.9.2 0.9.2+
1+
Compat 0.24.0 0.24.0+
2+
DocStringExtensions 0.3.3 0.3.3+
3+
Documenter 0.10.0 0.10.0+

doc/make.jl

+1
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ makedocs(
120120
clean = false,
121121
doctest = "doctest" in ARGS,
122122
linkcheck = "linkcheck" in ARGS,
123+
linkcheck_ignore = ["https://bugs.kde.org/show_bug.cgi?id=136779"], # fails to load from nanosoldier?
123124
strict = true,
124125
checkdocs = :none,
125126
format = "pdf" in ARGS ? :latex : :html,

doc/src/manual/constructors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ Point{Int64}(1, 2)
301301
julia> Point{Int64}(1.0,2.5) ## explicit T ##
302302
ERROR: InexactError()
303303
Stacktrace:
304-
[1] convert(::Type{Int64}, ::Float64) at ./float.jl:675
304+
[1] convert(::Type{Int64}, ::Float64) at ./float.jl:679
305305
[2] Point{Int64}(::Float64, ::Float64) at ./none:2
306306
307307
julia> Point{Float64}(1.0, 2.5) ## explicit T ##

doc/src/manual/mathematical-operations.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -366,10 +366,10 @@ You can also find the numerical precedence for any given operator via the built-
366366

367367
```jldoctest
368368
julia> Base.operator_precedence(:+), Base.operator_precedence(:*), Base.operator_precedence(:.)
369-
(9,11,15)
369+
(9, 11, 15)
370370
371371
julia> Base.operator_precedence(:+=), Base.operator_precedence(:(=)) # (Note the necessary parens on `:(=)`)
372-
(1,1)
372+
(1, 1)
373373
```
374374

375375
## Numerical Conversions
@@ -405,13 +405,13 @@ julia> Int8(127.0)
405405
julia> Int8(3.14)
406406
ERROR: InexactError()
407407
Stacktrace:
408-
[1] convert(::Type{Int8}, ::Float64) at ./float.jl:654
408+
[1] convert(::Type{Int8}, ::Float64) at ./float.jl:658
409409
[2] Int8(::Float64) at ./sysimg.jl:24
410410
411411
julia> Int8(128.0)
412412
ERROR: InexactError()
413413
Stacktrace:
414-
[1] convert(::Type{Int8}, ::Float64) at ./float.jl:654
414+
[1] convert(::Type{Int8}, ::Float64) at ./float.jl:658
415415
[2] Int8(::Float64) at ./sysimg.jl:24
416416
417417
julia> 127 % Int8
@@ -426,8 +426,8 @@ julia> round(Int8,127.4)
426426
julia> round(Int8,127.6)
427427
ERROR: InexactError()
428428
Stacktrace:
429-
[1] trunc(::Type{Int8}, ::Float64) at ./float.jl:647
430-
[2] round(::Type{Int8}, ::Float64) at ./float.jl:333
429+
[1] trunc(::Type{Int8}, ::Float64) at ./float.jl:651
430+
[2] round(::Type{Int8}, ::Float64) at ./float.jl:337
431431
```
432432

433433
See [Conversion and Promotion](@ref conversion-and-promotion) for how to define your own conversions and promotions.

doc/src/manual/types.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ must be convertible to `Int`:
341341
julia> Foo((), 23.5, 1)
342342
ERROR: InexactError()
343343
Stacktrace:
344-
[1] convert(::Type{Int64}, ::Float64) at ./float.jl:675
344+
[1] convert(::Type{Int64}, ::Float64) at ./float.jl:679
345345
[2] Foo(::Tuple{}, ::Float64, ::Int64) at ./none:2
346346
```
347347

test/perf/perfutil.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ macro timeit_init(ex,init,name,desc,group...)
9696
t[i] = e
9797
end
9898
end
99-
@output_timings t $name $desc $group
99+
@output_timings t $(esc(name)) $(esc(desc)) $(esc(group))
100100
end
101101
end
102102

0 commit comments

Comments
 (0)