Skip to content

Commit

Permalink
Fix broadcast_similar docstring
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
mbauman committed Apr 23, 2018
1 parent 6fdb86e commit df51b31
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions base/broadcast.jl
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,12 @@ Base.show(io::IO, bc::Broadcasted{Style}) where {Style} = print(io, Broadcasted,

## Allocating the output container
"""
broadcast_similar(::BroadcastStyle, ::Type{ElType}, inds, As...)
broadcast_similar(::BroadcastStyle, ::Type{ElType}, inds, bc)
Allocate an output object for [`broadcast`](@ref), appropriate for the indicated
[`Broadcast.BroadcastStyle`](@ref). `ElType` and `inds` specify the desired element type and axes of the
container. `As...` are the input arguments supplied to `broadcast`.
container. The final `bc` argument is the `Broadcasted` object representing the fused broadcast operation
and its arguments.
"""
broadcast_similar(::DefaultArrayStyle{N}, ::Type{ElType}, inds::Indices{N}, bc) where {N,ElType} =
similar(Array{ElType}, inds)
Expand Down
2 changes: 1 addition & 1 deletion base/deprecated.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1116,7 +1116,7 @@ end
@deprecate indices(a, d) axes(a, d)

# And similar _indices names in Broadcast
@eval Broadcast Base.@deprecate_binding broadcast_indices broadcast_axes false
@eval Broadcast Base.@deprecate_binding broadcast_indices broadcast_axes true
@eval Broadcast Base.@deprecate_binding check_broadcast_indices check_broadcast_axes false

# PR #25046
Expand Down

0 comments on commit df51b31

Please sign in to comment.