Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc fixes #19701

Merged
merged 7 commits into from
Dec 25, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion base/array.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
28 changes: 14 additions & 14 deletions base/docs/helpdb/Base.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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).
"""
Expand Down Expand Up @@ -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).
"""
Expand Down
4 changes: 2 additions & 2 deletions base/linalg/eigen.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
"""
Expand Down Expand Up @@ -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
```
"""
Expand Down
6 changes: 3 additions & 3 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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."
2 changes: 1 addition & 1 deletion doc/REQUIRE
Original file line number Diff line number Diff line change
@@ -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+
4 changes: 2 additions & 2 deletions doc/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion doc/src/manual/linear-algebra.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
6 changes: 2 additions & 4 deletions doc/src/stdlib/arrays.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/src/stdlib/dates.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ 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)
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)
Expand Down