Merge pull request JuliaLang#16585 from tkelman/tk/docfixes

Fix some documentation and deprecation issues

base/LineEdit.jl

@@ -909,7 +909,7 @@ function keymap{D<:Dict}(keymaps::Array{D})
 end
 
 const escape_defaults = merge!(
- AnyDict([Char(i) => nothing for i=vcat(1:26, 28:31)]), # Ignore control characters by default
+ AnyDict(Char(i) => nothing for i=vcat(1:26, 28:31)), # Ignore control characters by default
  AnyDict( # And ignore other escape sequences by default
  "\e*" => nothing,
  "\e[*" => nothing,
@@ -941,9 +941,9 @@ const escape_defaults = merge!(
  "\eOF" => KeyAlias("\e[F"),
  ),
  # set mode commands
- AnyDict(["\e[$(c)h" => nothing for c in 1:20]),
+ AnyDict("\e[$(c)h" => nothing for c in 1:20),
  # reset mode commands
- AnyDict(["\e[$(c)l" => nothing for c in 1:20])
+ AnyDict("\e[$(c)l" => nothing for c in 1:20)
  )
 
 function write_response_buffer(s::PromptState, data)
@@ -1456,11 +1456,11 @@ const prefix_history_keymap = merge!(
  "\e[200~" => "*"
  ),
  # VT220 editing commands
- AnyDict(["\e[$(n)~" => "*" for n in 1:8]),
+ AnyDict("\e[$(n)~" => "*" for n in 1:8),
  # set mode commands
- AnyDict(["\e[$(c)h" => "*" for c in 1:20]),
+ AnyDict("\e[$(c)h" => "*" for c in 1:20),
  # reset mode commands
- AnyDict(["\e[$(c)l" => "*" for c in 1:20])
+ AnyDict("\e[$(c)l" => "*" for c in 1:20)
 )
 
 function setup_prefix_keymap(hp, parent_prompt)

base/deprecated.jl

@@ -884,6 +884,8 @@ function rem1{T<:Real}(x::T, y::T)
  depwarn("`rem1(x,y)` is discontinued, as it cannot be defined consistently for `x==0`. Rewrite the expression using `mod1` instead.", :rem1)
  rem(x-1,y)+1
 end
+rem1(x::Real, y::Real) = rem1(promote(x,y)...)
+export rem1
 
 # Filesystem module updates
 

base/docs/helpdb/Base.jl

@@ -2886,7 +2886,7 @@ showcompact
  isleaftype(T)
 
 Determine whether `T` is a concrete type that can have instances, meaning its only subtypes
-are itself and `None` (but `T` itself is not `None`).
+are itself and `Union{}` (but `T` itself is not `Union{}`).
 """
 isleaftype
 
@@ -3279,7 +3279,7 @@ Redirect I/O to or from the given `command`. Keyword arguments specify which of
 command's streams should be redirected. `append` controls whether file output appends to the
 file. This is a more general version of the 2-argument `pipeline` function.
 `pipeline(from, to)` is equivalent to `pipeline(from, stdout=to)` when `from` is a command,
-and to `pipe(to, stdin=from)` when `from` is another kind of data source.
+and to `pipeline(to, stdin=from)` when `from` is another kind of data source.
 
 **Examples**:
 
@@ -3329,14 +3329,6 @@ The lowest value representable by the given (real) numeric DataType `T`.
 """
 typemin
 
-"""
- call(x, args...)
-
-If `x` is not a `Function`, then `x(args...)` is equivalent to `call(x, args...)`. This
-means that function-like behavior can be added to any type by defining new `call` methods.
-"""
-call
-
 """
  countfrom(start=1, step=1)
 
@@ -3960,7 +3952,7 @@ colon
  Base64EncodePipe(ostream)
 
 Returns a new write-only I/O stream, which converts any bytes written to it into
-base64-encoded ASCII bytes written to `ostream`. Calling `close` on the `Base64Pipe` stream
+base64-encoded ASCII bytes written to `ostream`. Calling `close` on the `Base64EncodePipe` stream
 is necessary to complete the encoding (but does not close `ostream`).
 """
 Base64EncodePipe
@@ -4954,13 +4946,6 @@ The distance between `x` and the next larger representable floating-point value
 """
 eps(::AbstractFloat)
 
-"""
- rem1(x, y)
-
-(Deprecated.) Remainder after division, returning in the range `(0, y]`.
-"""
-rem1
-
 """
  isalpha(c::Union{Char,AbstractString}) -> Bool
 
@@ -6317,13 +6302,6 @@ Compute sine of `x`, where `x` is in degrees.
 """
 sind
 
-"""
- iseltype(A,T)
-
-Tests whether `A` or its elements are of type `T`.
-"""
-iseltype
-
 """
  min(x, y, ...)
 
@@ -7259,13 +7237,6 @@ lexicographically comparable types, and `lexless` will call `lexcmp` by default.
 """
 lexcmp
 
-"""
- inf(f)
-
-Returns positive infinity of the floating point type `f` or of the same floating point type as `f`.
-"""
-inf
-
 """
  isupper(c::Union{Char,AbstractString}) -> Bool
 
@@ -7631,13 +7602,6 @@ julia> "Hello " * "world"
 """
 Base.:(*)(s::AbstractString, t::AbstractString)
 
-"""
- complement!(s)
-
-Mutates [`IntSet`](:obj:`IntSet`) `s` into its set-complement.
-"""
-complement!
-
 """
  slice(A, inds...)
 
@@ -7933,13 +7897,6 @@ Cumulative product of `A` along a dimension, storing the result in `B`. The dime
 """
 cumprod!
 
-"""
- complement(s)
-
-Returns the set-complement of [`IntSet`](:obj:`IntSet`) `s`.
-"""
-complement
-
 """
  rethrow([e])
 
@@ -8548,8 +8505,8 @@ cos
  base64encode(args...)
 
 Given a `write`-like function `writefunc`, which takes an I/O stream as its first argument,
-`base64(writefunc, args...)` calls `writefunc` to write `args...` to a base64-encoded
-string, and returns the string. `base64(args...)` is equivalent to `base64(write, args...)`:
+`base64encode(writefunc, args...)` calls `writefunc` to write `args...` to a base64-encoded
+string, and returns the string. `base64encode(args...)` is equivalent to `base64encode(write, args...)`:
 it converts its arguments into bytes using the standard `write` functions and returns the
 base64-encoded string.
 """
@@ -9478,7 +9435,7 @@ Matrix trace.
 trace
 
 """
- runtests([tests=["all"] [, numcores=iceil(Sys.CPU_CORES / 2) ]])
+ runtests([tests=["all"] [, numcores=ceil(Integer, Sys.CPU_CORES / 2) ]])
 
 Run the Julia unit tests listed in `tests`, which can be either a string or an array of
 strings, using `numcores` processors. (not exported)
@@ -9587,13 +9544,6 @@ Unicode string.)
 """
 reverseind
 
-"""
- nan(f)
-
-Returns NaN (not-a-number) of the floating point type `f` or of the same floating point type as `f`
-"""
-nan
-
 """
  float(x)
 

base/exports.jl

@@ -418,7 +418,6 @@ export
  reim,
  reinterpret,
  rem,
- rem1,
  round,
  sec,
  secd,
@@ -1270,7 +1269,6 @@ export
  isblockdev,
  ischardev,
  isdir,
- isexecutable,
  isfifo,
  isfile,
  islink,

base/gmp.jl

@@ -201,24 +201,24 @@ function convert{T<:Signed}(::Type{T}, x::BigInt)
 end
 
 
-function call(::Type{Float64}, n::BigInt, ::RoundingMode{:ToZero})
+function (::Type{Float64})(n::BigInt, ::RoundingMode{:ToZero})
  ccall((:__gmpz_get_d, :libgmp), Float64, (Ptr{BigInt},), &n)
 end
 
-function call{T<:Union{Float16,Float32}}(::Type{T}, n::BigInt, ::RoundingMode{:ToZero})
+function (::Type{T}){T<:Union{Float16,Float32}}(n::BigInt, ::RoundingMode{:ToZero})
  T(Float64(n,RoundToZero),RoundToZero)
 end
 
-function call{T<:CdoubleMax}(::Type{T}, n::BigInt, ::RoundingMode{:Down})
+function (::Type{T}){T<:CdoubleMax}(n::BigInt, ::RoundingMode{:Down})
  x = T(n,RoundToZero)
  x > n ? prevfloat(x) : x
 end
-function call{T<:CdoubleMax}(::Type{T}, n::BigInt, ::RoundingMode{:Up})
+function (::Type{T}){T<:CdoubleMax}(n::BigInt, ::RoundingMode{:Up})
  x = T(n,RoundToZero)
  x < n ? nextfloat(x) : x
 end
 
-function call{T<:CdoubleMax}(::Type{T}, n::BigInt, ::RoundingMode{:Nearest})
+function (::Type{T}){T<:CdoubleMax}(n::BigInt, ::RoundingMode{:Nearest})
  x = T(n,RoundToZero)
  if maxintfloat(T) <= abs(x) < T(Inf)
  r = n-BigInt(x)

base/libgit2/callbacks.jl

@@ -27,27 +27,28 @@ end
 """Credentials callback function
 
 Function provides different credential acquisition functionality w.r.t. a connection protocol.
-If payload is provided then `payload_ptr` should contain `LibGit2.AbstractCredentials` object.
+If a payload is provided then `payload_ptr` should contain a `LibGit2.AbstractCredentials` object.
 
-For `LibGit2.Consts.CREDTYPE_USERPASS_PLAINTEXT` type, if payload contains fields:
+For `LibGit2.Consts.CREDTYPE_USERPASS_PLAINTEXT` type, if the payload contains fields:
 `user` & `pass`, they are used to create authentication credentials.
-Empty `user` name and `pass`word trigger authentication error.
+Empty `user` name and `pass`word trigger an authentication error.
 
-For `LibGit2.Consts.CREDTYPE_SSH_KEY` type, if payload contains fields:
+For `LibGit2.Consts.CREDTYPE_SSH_KEY` type, if the payload contains fields:
 `user`, `prvkey`, `pubkey` & `pass`, they are used to create authentication credentials.
-Empty `user` name triggers authentication error.
+Empty `user` name triggers an authentication error.
 
-Order of credential checks (if supported):
-- ssh key pair (ssh-agent if specified in payload's `usesshagent` field)
+Credentials are checked in the following order (if supported):
+- ssh key pair (`ssh-agent` if specified in payload's `usesshagent` field)
 - plain text
 
-**Note**: Due to the specifics of `libgit2` authentication procedure, when authentication fails,
-this function is called again without any indication whether authentication was successful or not.
-To avoid an infinite loop from repeatedly using the same faulty credentials,
-`checkused!` function can be called to test if credentials were used if call returns `true` value.
-Used credentials trigger user prompt for (re)entering required information.
-`UserPasswordCredentials` and `CachedCredentials` are implemented using a call counting strategy
-that prevents repeated usage of faulty credentials.
+**Note**: Due to the specifics of the `libgit2` authentication procedure, when
+authentication fails, this function is called again without any indication whether
+authentication was successful or not. To avoid an infinite loop from repeatedly
+using the same faulty credentials, the `checkused!` function can be called. This
+function returns `true` if the credentials were used.
+Using credentials triggers a user prompt for (re)entering required information.
+`UserPasswordCredentials` and `CachedCredentials` are implemented using a call
+counting strategy that prevents repeated usage of faulty credentials.
 """
 function credentials_callback(cred::Ptr{Ptr{Void}}, url_ptr::Cstring,
  username_ptr::Cstring,

base/libgit2/types.jl

@@ -63,7 +63,7 @@ function Base.getindex(p::AbstractCredentials, keys...)
  end
  return nothing
 end
-"Sets credentials with `key` parameter with value"
+"Sets credentials with `key` parameter to a value"
 function Base.setindex!(p::AbstractCredentials, val, keys...)
  for k in keys
  ks = Symbol(k)
@@ -73,7 +73,7 @@ function Base.setindex!(p::AbstractCredentials, val, keys...)
 end
 "Checks if credentials were used"
 checkused!(p::AbstractCredentials) = true
-"Resets credentials for another usage"
+"Resets credentials for another use"
 reset!(p::AbstractCredentials, cnt::Int=3) = nothing
 
 immutable CheckoutOptions
@@ -745,7 +745,8 @@ type CachedCredentials <: AbstractCredentials
  count::Int # authentication failure protection count
  CachedCredentials() = new(Dict{AbstractString,SSHCredentials}(),3)
 end
-"Returns specific credential parameter value: first index is a credential parameter name, second index is a host name (with schema)"
+"Returns specific credential parameter value: first index is a credential
+parameter name, second index is a host name (with schema)"
 function Base.getindex(p::CachedCredentials, keys...)
  length(keys) != 2 && return nothing
  key, host = keys
@@ -758,7 +759,8 @@ function Base.getindex(p::CachedCredentials, keys...)
  end
  return nothing
 end
-"Sets specific credential parameter value: first index is a credential parameter name, second index is a host name (with schema)"
+"Sets specific credential parameter value: first index is a credential
+parameter name, second index is a host name (with schema)"
 function Base.setindex!(p::CachedCredentials, val, keys...)
  length(keys) != 2 && return nothing
  key, host = keys

base/mpfr.jl

@@ -177,13 +177,13 @@ convert(::Type{Float32}, x::BigFloat) =
 # TODO: avoid double rounding
 convert(::Type{Float16}, x::BigFloat) = convert(Float16, convert(Float32, x))
 
-call(::Type{Float64}, x::BigFloat, r::RoundingMode) =
+(::Type{Float64})(x::BigFloat, r::RoundingMode) =
  ccall((:mpfr_get_d,:libmpfr), Float64, (Ptr{BigFloat},Int32), &x, to_mpfr(r))
-call(::Type{Float32}, x::BigFloat, r::RoundingMode) =
+(::Type{Float32})(x::BigFloat, r::RoundingMode) =
  ccall((:mpfr_get_flt,:libmpfr), Float32, (Ptr{BigFloat},Int32), &x, to_mpfr(r))
 # TODO: avoid double rounding
-call(::Type{Float16}, x::BigFloat, r::RoundingMode) =
- convert(Float16, call(Float32, x, r))
+(::Type{Float16})(x::BigFloat, r::RoundingMode) =
+ convert(Float16, Float32(x, r))
 
 promote_rule{T<:Real}(::Type{BigFloat}, ::Type{T}) = BigFloat
 promote_rule{T<:AbstractFloat}(::Type{BigInt},::Type{T}) = BigFloat

base/pkg/resolve.jl

@@ -75,7 +75,7 @@ function sanity_check(deps::Dict{String,Dict{VersionNumber,Available}},
 
  nv = length(vers)
 
- svdict = (Tuple{String,VersionNumber}=>Int)[ vers[i][1:2]=>i for i = 1:nv ]
+ svdict = Dict{Tuple{String,VersionNumber},Int}(vers[i][1:2]=>i for i = 1:nv)
 
  checked = falses(nv)
 

base/pkg/resolve/interface.jl

@@ -49,7 +49,7 @@ type Interface
  np = length(pkgs)
 
  # generate pdict
- pdict = (String=>Int)[ pkgs[i] => i for i = 1:np ]
+ pdict = Dict{String,Int}(pkgs[i] => i for i = 1:np)
 
  # generate spp and pvers
  spp = Array{Int}(np)

base/promotion.jl

@@ -211,7 +211,6 @@ rem(x::Real, y::Real) = rem(promote(x,y)...)
 mod(x::Real, y::Real) = mod(promote(x,y)...)
 
 mod1(x::Real, y::Real) = mod1(promote(x,y)...)
-rem1(x::Real, y::Real) = rem1(promote(x,y)...)
 fld1(x::Real, y::Real) = fld1(promote(x,y)...)
 
 max(x::Real, y::Real) = max(promote(x,y)...)

base/rounding.jl

@@ -67,7 +67,7 @@ end
 # Assumes conversion is performed by rounding to nearest value.
 
 # To avoid ambiguous dispatch with methods in mpfr.jl:
-call{T<:AbstractFloat}(::Type{T},x::Real,r::RoundingMode) = _convert_rounding(T,x,r)
+(::Type{T}){T<:AbstractFloat}(x::Real,r::RoundingMode) = _convert_rounding(T,x,r)
 
 _convert_rounding{T<:AbstractFloat}(::Type{T},x::Real,r::RoundingMode{:Nearest}) = convert(T,x)
 function _convert_rounding{T<:AbstractFloat}(::Type{T},x::Real,r::RoundingMode{:Down})

base/strings/types.jl

@@ -1,6 +1,6 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
-# SubString, RevString, RepString, and RopeString types
+# SubString, RevString, and RepString types
 
 ## substrings reference original strings ##
 

base/sysinfo.jl

@@ -180,7 +180,7 @@ end
  windows_version()
 
 Returns the version number for the Windows NT Kernel as a (major, minor) pair,
-or (0, 0) if this is not running on Windows.
+or `(0, 0)` if this is not running on Windows.
 """
 windows_version
 

base/unicode/utf8proc.jl

@@ -10,7 +10,7 @@ export isgraphemebreak
 # also exported by Base:
 export normalize_string, graphemes, is_assigned_char, charwidth, isvalid,
  islower, isupper, isalpha, isdigit, isnumber, isalnum,
- iscntrl, ispunct, isspace, isprint, isgraph, isblank
+ iscntrl, ispunct, isspace, isprint, isgraph
 
 # whether codepoints are valid Unicode scalar values, i.e. 0-0xd7ff, 0xe000-0x10ffff
 isvalid(::Type{Char}, ch::Unsigned) = !((ch - 0xd800 < 0x800) | (ch > 0x10ffff))