From 610919d1f0742eadc2487ccb9ca290aaaae1e3d1 Mon Sep 17 00:00:00 2001 From: Michael Hatherly Date: Fri, 23 Dec 2016 23:04:17 +0200 Subject: [PATCH 1/7] Fix doc signatures for zeros/ones https://github.com/JuliaLang/julia/pull/19635 merged two docstrings for each of `zeros` and `ones` in a single docstring each. This changes the signatures in the stdlib file to reflect that change. --- doc/src/stdlib/arrays.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/src/stdlib/arrays.md b/doc/src/stdlib/arrays.md index da1ada67b662d..7e699a3f5f119 100644 --- a/doc/src/stdlib/arrays.md +++ b/doc/src/stdlib/arrays.md @@ -25,10 +25,8 @@ Base.LinAlg.checksquare ```@docs Core.Array Base.getindex(::Type, ::Any...) -Base.zeros(::Any, ::Any) -Base.zeros(::Any) -Base.ones(::Any, ::Any) -Base.ones(::Any) +Base.zeros +Base.ones Base.BitArray Base.trues Base.falses From 552e34c5fa01defaa4f568d80ebce5e9990c18c4 Mon Sep 17 00:00:00 2001 From: Michael Hatherly Date: Fri, 23 Dec 2016 23:06:53 +0200 Subject: [PATCH 2/7] Run doc deps `update` prior to `resolve` This avoids an error that occurs when documentaion dep versions have been updated, but `Pkg.update` hasn't been called which results in `Pkg.resolve` not being able to find suitable package versions. --- doc/make.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/make.jl b/doc/make.jl index a657a799c16c0..8a527e070bc41 100644 --- a/doc/make.jl +++ b/doc/make.jl @@ -2,8 +2,8 @@ ENV["JULIA_PKGDIR"] = joinpath(@__DIR__, "deps") Pkg.init() cp(joinpath(@__DIR__, "REQUIRE"), Pkg.dir("REQUIRE"); remove_destination = true) -Pkg.resolve() Pkg.update() +Pkg.resolve() using Documenter From 9fe3ba1ac16174de00832ba05f6e01627ebdd4a6 Mon Sep 17 00:00:00 2001 From: Michael Hatherly Date: Fri, 23 Dec 2016 23:09:17 +0200 Subject: [PATCH 3/7] Always build docs using `strict = true` This should make travis builds on PRs fail when changes are made that cause `doc/make.jl` to raise warnings that need to be addressed prior to merging. --- doc/Makefile | 6 +++--- doc/make.jl | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index cd6e3693b4261..ea3c00710c481 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -41,15 +41,15 @@ pdf: linkcheck: @echo "Checking external documentation links." - $(JULIA_EXECUTABLE) make.jl -- linkcheck strict + $(JULIA_EXECUTABLE) make.jl -- linkcheck @echo "Checks finished." doctest: @echo "Running all embedded 'doctests'." - $(JULIA_EXECUTABLE) make.jl -- doctest strict + $(JULIA_EXECUTABLE) make.jl -- doctest @echo "Checks finished." check: @echo "Running all embedded 'doctests' and checking external links." - $(JULIA_EXECUTABLE) make.jl -- doctest linkcheck strict + $(JULIA_EXECUTABLE) make.jl -- doctest linkcheck @echo "Checks finished." diff --git a/doc/make.jl b/doc/make.jl index 8a527e070bc41..720c524a78f73 100644 --- a/doc/make.jl +++ b/doc/make.jl @@ -118,7 +118,7 @@ makedocs( clean = false, doctest = "doctest" in ARGS, linkcheck = "linkcheck" in ARGS, - strict = "strict" in ARGS, + strict = true, checkdocs = :none, format = "pdf" in ARGS ? :latex : :html, sitename = "The Julia Language", From e19ed0a0f95795dbf2bafd757be7987737397280 Mon Sep 17 00:00:00 2001 From: Michael Hatherly Date: Sat, 24 Dec 2016 00:18:11 +0200 Subject: [PATCH 4/7] Change Date/DateTime signatures to use Int64 Fixes docs builds on 32bit platforms. --- doc/src/stdlib/dates.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/src/stdlib/dates.md b/doc/src/stdlib/dates.md index 2d240e52b78e5..ec90098f754e4 100644 --- a/doc/src/stdlib/dates.md +++ b/doc/src/stdlib/dates.md @@ -21,7 +21,7 @@ function call with an explicit `Dates.`, e.g. `Dates.dayofweek(dt)`. Alternative prefix. ```@docs -Base.Dates.DateTime(::Int, ::Int, ::Int, ::Int, ::Int, ::Int, ::Int) +Base.Dates.DateTime(::Int64, ::Int64, ::Int64, ::Int64, ::Int64, ::Int64, ::Int64) Base.Dates.DateTime(::Base.Dates.Period...) Base.Dates.DateTime(::Function, ::Any...) Base.Dates.DateTime(::Base.Dates.TimeType) @@ -29,7 +29,7 @@ Base.Dates.DateTime(::AbstractString, ::AbstractString) Base.Dates.format Base.Dates.DateFormat Base.Dates.DateTime(::AbstractString, ::Base.Dates.DateFormat) -Base.Dates.Date(::Int, ::Int, ::Int) +Base.Dates.Date(::Int64, ::Int64, ::Int64) Base.Dates.Date(::Base.Dates.Period...) Base.Dates.Date(::Function, ::Any, ::Any, ::Any) Base.Dates.Date(::Base.Dates.TimeType) From a4a21a5167bff5b424e54c2e55f9b780059d2581 Mon Sep 17 00:00:00 2001 From: Michael Hatherly Date: Sat, 24 Dec 2016 12:56:35 +0200 Subject: [PATCH 5/7] Update Documenter version to 0.8.5 --- doc/REQUIRE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/REQUIRE b/doc/REQUIRE index fb116ed202112..4a3d78f045e19 100644 --- a/doc/REQUIRE +++ b/doc/REQUIRE @@ -1,3 +1,3 @@ Compat 0.9.5 0.9.5+ DocStringExtensions 0.3.1 0.3.1+ -Documenter 0.8.4 0.8.4+ +Documenter 0.8.5 0.8.5+ From 90003ad43a48950992344e88b090052af4ea16e5 Mon Sep 17 00:00:00 2001 From: Michael Hatherly Date: Sat, 24 Dec 2016 12:57:31 +0200 Subject: [PATCH 6/7] Fix up doctests --- base/array.jl | 2 +- base/docs/helpdb/Base.jl | 28 ++++++++++++++-------------- base/linalg/eigen.jl | 4 ++-- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/base/array.jl b/base/array.jl index 793037106cb39..f4f507b92dfb6 100644 --- a/base/array.jl +++ b/base/array.jl @@ -737,7 +737,7 @@ julia> deleteat!([6, 5, 4, 3, 2, 1], 1:2:5) julia> deleteat!([6, 5, 4, 3, 2, 1], (2, 2)) ERROR: ArgumentError: indices must be unique and sorted - in deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:747 + in deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:753 ``` """ function deleteat!(a::Vector, inds) diff --git a/base/docs/helpdb/Base.jl b/base/docs/helpdb/Base.jl index 57d07e3300dc6..0e4bfb83edb5d 100644 --- a/base/docs/helpdb/Base.jl +++ b/base/docs/helpdb/Base.jl @@ -577,16 +577,16 @@ julia> ones(A) 1 1 1 1 - julia> ones(A, Float64) +julia> ones(A, Float64) 2×2 Array{Float64,2}: - 1. 1. - 1. 1. + 1.0 1.0 + 1.0 1.0 - julia> ones(A, Bool, (3,)) - 3-element Array{Bool,1}: - true - true - true +julia> ones(A, Bool, (3,)) +3-element Array{Bool,1}: + true + true + true ``` See also [`zeros`](@ref), [`similar`](@ref). """ @@ -2726,16 +2726,16 @@ julia> zeros(A) 0 0 0 0 - julia> zeros(A, Float64) +julia> zeros(A, Float64) 2×2 Array{Float64,2}: 0.0 0.0 0.0 0.0 - julia> zeros(A, Bool, (3,)) - 3-element Array{Bool,1}: - false - false - false +julia> zeros(A, Bool, (3,)) +3-element Array{Bool,1}: + false + false + false ``` See also [`ones`](@ref), [`similar`](@ref). """ diff --git a/base/linalg/eigen.jl b/base/linalg/eigen.jl index 93203248430e6..1a91f491a6943 100644 --- a/base/linalg/eigen.jl +++ b/base/linalg/eigen.jl @@ -208,7 +208,7 @@ julia> A = [0 im; -1 0] julia> eigmax(A) ERROR: DomainError: - in #eigmax#30(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:218 + in #eigmax#36(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:218 in eigmax(::Array{Complex{Int64},2}) at ./linalg/eigen.jl:216 ``` """ @@ -249,7 +249,7 @@ julia> A = [0 im; -1 0] julia> eigmin(A) ERROR: DomainError: - in #eigmin#31(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:259 + in #eigmin#37(::Bool, ::Bool, ::Function, ::Array{Complex{Int64},2}) at ./linalg/eigen.jl:259 in eigmin(::Array{Complex{Int64},2}) at ./linalg/eigen.jl:257 ``` """ From ea8dabad02f701f2ad5b6ed24f1d99210a8fa1a1 Mon Sep 17 00:00:00 2001 From: Michael Hatherly Date: Sat, 24 Dec 2016 22:49:52 +0200 Subject: [PATCH 7/7] Wrap 'Tridiagonal' ref in backticks --- doc/src/manual/linear-algebra.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/manual/linear-algebra.md b/doc/src/manual/linear-algebra.md index a9e487dafd6bf..5675fe0d17687 100644 --- a/doc/src/manual/linear-algebra.md +++ b/doc/src/manual/linear-algebra.md @@ -15,7 +15,7 @@ of the standard library documentation. | `Cholesky` | [Cholesky factorization](https://en.wikipedia.org/wiki/Cholesky_decomposition) | | `CholeskyPivoted` | [Pivoted](https://en.wikipedia.org/wiki/Pivot_element) Cholesky factorization | | `LU` | [LU factorization](https://en.wikipedia.org/wiki/LU_decomposition) | -| `LUTridiagonal` | LU factorization for [Tridiagonal](@ref) matrices | +| `LUTridiagonal` | LU factorization for [`Tridiagonal`](@ref) matrices | | `UmfpackLU` | LU factorization for sparse matrices (computed by UMFPack) | | `QR` | [QR factorization](https://en.wikipedia.org/wiki/QR_decomposition) | | `QRCompactWY` | Compact WY form of the QR factorization |