Fix docstrings in nullable.jl #19067
Conversation
| """ | ||
| Nullable(x, hasvalue::Bool=true) | ||
|
|
||
| When `hasvalue` is true, wrap value `x` in an object of type `Nullable`, which indicates |
There was a problem hiding this comment.
I think I would phrase it slightly differently: as the original docstring said (even though it was incomplete), x is always wrapped in the resulting Nullable. The hasvalue argument will determine whether the value will be considered present or not, but it's actually always there in the value field of the result (cf. #16923).
The hasvalue argument is useful only in quite specific cases, so I'd mention it only in a separate paragraph, to keep the explanation for the one-argument form simple. The fist paragraph could almost be kept as it is currently.
There was a problem hiding this comment.
I think I would phrase it slightly differently: as the original docstring said (even though it was incomplete), x is always wrapped in the resulting Nullable. The hasvalue argument will determine whether the value will be considered present or not, but it's actually always there in the value field of the result (cf. #16923).
I appreciate the explanation and reference. I understand the behavior better now.
The hasvalue argument is useful only in quite specific cases, so I'd mention it only in a separate paragraph, to keep the explanation for the one-argument form simple. The fist paragraph could almost be kept as it is currently.
Now the hasvalue argument is addressed in the second paragraph of the docstring only. I've included an additional doctest to better illustrate behavior when hasvalue is false.
Thanks!
nalimilan
added
missing data
|
Thanks! Looks like I indeed missed these when changing the meaning of the second argument to |
| # Examples | ||
|
|
||
| ```jldoctest | ||
| julia> x = 1; Nullable(x) |
There was a problem hiding this comment.
Why not replace x with 1 directly in the expressions?
There was a problem hiding this comment.
Good point. Fixed it!
| julia> Nullable(x, false) | ||
| Nullable{Int64}() | ||
|
|
||
| julia> dump(Nullable(x, false)) |
There was a problem hiding this comment.
Good idea to show this indeed!
This moves inline and edits the docstring for
Nullable, adding doctests and changing the function signature. Also fixes the doctests forisnull. Thank you in advance for reviewing :)