Skip to content

Commit 55b1230

Browse files
authored
Merge pull request JuliaLang#19701 from MichaelHatherly/mh/doc-fixes-4
Doc fixes
2 parents 9b414f2 + ea8daba commit 55b1230

File tree

9 files changed

+28
-30
lines changed

9 files changed

+28
-30
lines changed

base/array.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -737,7 +737,7 @@ julia> deleteat!([6, 5, 4, 3, 2, 1], 1:2:5)
737737
738738
julia> deleteat!([6, 5, 4, 3, 2, 1], (2, 2))
739739
ERROR: ArgumentError: indices must be unique and sorted
740-
in deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:747
740+
in deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:753
741741
```
742742
"""
743743
function deleteat!(a::Vector, inds)

base/docs/helpdb/Base.jl

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -577,16 +577,16 @@ julia> ones(A)
577577
1 1
578578
1 1
579579
580-
julia> ones(A, Float64)
580+
julia> ones(A, Float64)
581581
2×2 Array{Float64,2}:
582-
1. 1.
583-
1. 1.
582+
1.0 1.0
583+
1.0 1.0
584584
585-
julia> ones(A, Bool, (3,))
586-
3-element Array{Bool,1}:
587-
true
588-
true
589-
true
585+
julia> ones(A, Bool, (3,))
586+
3-element Array{Bool,1}:
587+
true
588+
true
589+
true
590590
```
591591
See also [`zeros`](@ref), [`similar`](@ref).
592592
"""
@@ -2726,16 +2726,16 @@ julia> zeros(A)
27262726
0 0
27272727
0 0
27282728
2729-
julia> zeros(A, Float64)
2729+
julia> zeros(A, Float64)
27302730
2×2 Array{Float64,2}:
27312731
0.0 0.0
27322732
0.0 0.0
27332733
2734-
julia> zeros(A, Bool, (3,))
2735-
3-element Array{Bool,1}:
2736-
false
2737-
false
2738-
false
2734+
julia> zeros(A, Bool, (3,))
2735+
3-element Array{Bool,1}:
2736+
false
2737+
false
2738+
false
27392739
```
27402740
See also [`ones`](@ref), [`similar`](@ref).
27412741
"""

base/linalg/eigen.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ julia> A = [0 im; -1 0]
208208
209209
julia> eigmax(A)
210210
ERROR: DomainError:
211-
in #eigmax#30(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:218
211+
in #eigmax#36(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:218
212212
in eigmax(::Array{Complex{Int64},2}) at ./linalg/eigen.jl:216
213213
```
214214
"""
@@ -249,7 +249,7 @@ julia> A = [0 im; -1 0]
249249
250250
julia> eigmin(A)
251251
ERROR: DomainError:
252-
in #eigmin#31(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:259
252+
in #eigmin#37(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:259
253253
in eigmin(::Array{Complex{Int64},2}) at ./linalg/eigen.jl:257
254254
```
255255
"""

doc/Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ pdf:
4141

4242
linkcheck:
4343
@echo "Checking external documentation links."
44-
$(JULIA_EXECUTABLE) make.jl -- linkcheck strict
44+
$(JULIA_EXECUTABLE) make.jl -- linkcheck
4545
@echo "Checks finished."
4646

4747
doctest:
4848
@echo "Running all embedded 'doctests'."
49-
$(JULIA_EXECUTABLE) make.jl -- doctest strict
49+
$(JULIA_EXECUTABLE) make.jl -- doctest
5050
@echo "Checks finished."
5151

5252
check:
5353
@echo "Running all embedded 'doctests' and checking external links."
54-
$(JULIA_EXECUTABLE) make.jl -- doctest linkcheck strict
54+
$(JULIA_EXECUTABLE) make.jl -- doctest linkcheck
5555
@echo "Checks finished."

doc/REQUIRE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Compat 0.9.5 0.9.5+
22
DocStringExtensions 0.3.1 0.3.1+
3-
Documenter 0.8.4 0.8.4+
3+
Documenter 0.8.5 0.8.5+

doc/make.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
ENV["JULIA_PKGDIR"] = joinpath(@__DIR__, "deps")
33
Pkg.init()
44
cp(joinpath(@__DIR__, "REQUIRE"), Pkg.dir("REQUIRE"); remove_destination = true)
5-
Pkg.resolve()
65
Pkg.update()
6+
Pkg.resolve()
77

88
using Documenter
99

@@ -118,7 +118,7 @@ makedocs(
118118
clean = false,
119119
doctest = "doctest" in ARGS,
120120
linkcheck = "linkcheck" in ARGS,
121-
strict = "strict" in ARGS,
121+
strict = true,
122122
checkdocs = :none,
123123
format = "pdf" in ARGS ? :latex : :html,
124124
sitename = "The Julia Language",

doc/src/manual/linear-algebra.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ of the standard library documentation.
1515
| `Cholesky` | [Cholesky factorization](https://en.wikipedia.org/wiki/Cholesky_decomposition) |
1616
| `CholeskyPivoted` | [Pivoted](https://en.wikipedia.org/wiki/Pivot_element) Cholesky factorization |
1717
| `LU` | [LU factorization](https://en.wikipedia.org/wiki/LU_decomposition) |
18-
| `LUTridiagonal` | LU factorization for [Tridiagonal](@ref) matrices |
18+
| `LUTridiagonal` | LU factorization for [`Tridiagonal`](@ref) matrices |
1919
| `UmfpackLU` | LU factorization for sparse matrices (computed by UMFPack) |
2020
| `QR` | [QR factorization](https://en.wikipedia.org/wiki/QR_decomposition) |
2121
| `QRCompactWY` | Compact WY form of the QR factorization |

doc/src/stdlib/arrays.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,8 @@ Base.LinAlg.checksquare
2525
```@docs
2626
Core.Array
2727
Base.getindex(::Type, ::Any...)
28-
Base.zeros(::Any, ::Any)
29-
Base.zeros(::Any)
30-
Base.ones(::Any, ::Any)
31-
Base.ones(::Any)
28+
Base.zeros
29+
Base.ones
3230
Base.BitArray
3331
Base.trues
3432
Base.falses

doc/src/stdlib/dates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ function call with an explicit `Dates.`, e.g. `Dates.dayofweek(dt)`. Alternative
2121
prefix.
2222

2323
```@docs
24-
Base.Dates.DateTime(::Int, ::Int, ::Int, ::Int, ::Int, ::Int, ::Int)
24+
Base.Dates.DateTime(::Int64, ::Int64, ::Int64, ::Int64, ::Int64, ::Int64, ::Int64)
2525
Base.Dates.DateTime(::Base.Dates.Period...)
2626
Base.Dates.DateTime(::Function, ::Any...)
2727
Base.Dates.DateTime(::Base.Dates.TimeType)
2828
Base.Dates.DateTime(::AbstractString, ::AbstractString)
2929
Base.Dates.format
3030
Base.Dates.DateFormat
3131
Base.Dates.DateTime(::AbstractString, ::Base.Dates.DateFormat)
32-
Base.Dates.Date(::Int, ::Int, ::Int)
32+
Base.Dates.Date(::Int64, ::Int64, ::Int64)
3333
Base.Dates.Date(::Base.Dates.Period...)
3434
Base.Dates.Date(::Function, ::Any, ::Any, ::Any)
3535
Base.Dates.Date(::Base.Dates.TimeType)

0 commit comments

Comments
 (0)