JuliaLang/julia
在 GitHub 查看Explicitly document the `missing` behavior for all functions that handle `missing` values
Open
#45,142 创建于 2022年5月1日
docsgood first issue
仓库指标
- Star
- (48,709 star)
- PR 合并指标
- (平均合并 20天 6小时) (30 天内合并 157 个 PR)
描述
I think that every function that handles missing values should have its handling of missing values documented in its docstring. There are two possible ways to do this:
- Add discussion of the handling of
missingvalues to the genericfoo(x)docstring. - Add separate docstrings for all the
foo(::Missing),bar(::Missing, ::Any), etc, methods.- This approach won't work for methods that take iterators, like
all,any,maximum, andminimum.
- This approach won't work for methods that take iterators, like
Functions that handle missing values currently do not have fully specified APIs, since their docstrings make no mention of missing values. My position is that docstrings should always strive to fully specify the API of their functions, so that in theory a person could write an entire application by referring only to the docstrings. In other words, you shouldn't have to run foo(missing) in the REPL in order to determine whether foo handles missing values.