Skip to content

Reattach the docstring for Future.abs2 #204

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.

Sign up for GitHub

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

Open
sotashimozono wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Reattach the docstring for Future.abs2 #204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions src/ColorVectorSpace.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,18 +485,17 @@ Base.abs2(c::Union{AbstractGray,AbstractRGB}) = c ⋅ c
module Future
using ..ColorTypes
using ..ColorVectorSpace: ⋅
"""
ColorVectorSpace.Future.abs2(c)
Return a scalar "squared magnitude" for color types. For RGB and gray, this is just the mean-square
channelwise intensity.
"""

if VERSION >= v"1.5"
@inline _depwarn(msg, funcsym; force=false) = Base.depwarn(msg, funcsym; force=force)
else
@inline _depwarn(msg, funcsym; force=false) = Base.depwarn(msg, funcsym)
end

"""
ColorVectorSpace.Future.abs2(c)
Return a scalar "squared magnitude" for color types. For RGB and gray, this is just the mean-square
channelwise intensity.
"""
function abs2(c::Union{Real,AbstractGray,AbstractRGB})
_depwarn("""
The return value of `abs2` is now consistent with `ColorVectorSpace.Future.abs2`.
Expand Down
Loading