Skip to content
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.

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

Help docs for median "checknan" keyword incorrect #8598

Closed
tinybike opened this issue Oct 6, 2014 · 2 comments
Closed

Help docs for median "checknan" keyword incorrect #8598

tinybike opened this issue Oct 6, 2014 · 2 comments
Labels
docs This change adds or pertains to documentation regression Regression in behavior compared to a previous version

Comments

@tinybike
Copy link

tinybike commented Oct 6, 2014

julia> help(median)
Base.median(v; checknan::Bool=true)

   Compute the median of a vector "v". If keyword argument
   "checknan" is true (the default), an error is raised for data
   containing NaN values. Note: Julia does not ignore "NaN" values
   in the computation. For applications requiring the handling of
   missing data, the "DataArray" package is recommended.

But, median actually returns NaN if the vector contains a NaN, rather than raising an error:

julia> x=[1,2,NaN];

julia> median(x)
NaN
@jiahao
Copy link
Member

jiahao commented Oct 6, 2014

The docs haven't been updated since #6820.

@jiahao jiahao added the docs This change adds or pertains to documentation label Oct 6, 2014
@ivarne ivarne added regression Regression in behavior compared to a previous version backport pending labels Oct 6, 2014
@ivarne
Copy link
Member

ivarne commented Oct 21, 2014

@simonster Can you have a look at this regarding a possible backport. I would like as much documentation update in 0.3.2 as possible, but I'm confused and think the code changes in e24fac0 looks like they maybe shouldn't be backported.

I can cherry pick only the documentation changes, but think it is better to ask than to just do it.

simonster added a commit that referenced this issue Oct 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation regression Regression in behavior compared to a previous version
Projects
None yet
Development

No branches or pull requests

3 participants