Add missing docstring for zero function which input is type
#37152
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note that the docstring already states that
|
staticfloat
reviewed
Aug 24, 2020
base/number.jl
Outdated
| @@ -223,6 +223,7 @@ map(f, x::Number, ys::Number...) = f(x, ys...) | |||
|
|
|||
| """ | |||
| zero(x) | |||
| zero(T::type) | |||
There was a problem hiding this comment.
I think it's a little clearer if this is labeled as zero(::Type{<:Number})
There was a problem hiding this comment.
There are types which are not <:Number but support zero, e.g. Dates.Day.
There was a problem hiding this comment.
True, but those are not hitting this particular method. It's probably okay to just call it ::Type then though.
There was a problem hiding this comment.
OK. I change it to ::Type
|
Thanks @AtsushiSakai! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I found
zerofunction can accept a type, not only a variable:But, its docstring looks like missing later one, so I added it.