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.

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

Jump to bottom

Improve docstrings for std and var #31200

Merged
merged 2 commits into from
Mar 1, 2019
Merged

Improve docstrings for std and var #31200

merged 2 commits into from
Mar 1, 2019

Conversation

nalimilan
Copy link
Member

[ci skip]

@nalimilan nalimilan added docs This change adds or pertains to documentation stdlib Julia's standard library labels Feb 28, 2019
nalimilan
nalimilan commented Feb 28, 2019
View reviewed changes
stdlib/Statistics/src/Statistics.jl

Compute the sample variance of a vector or array `v`, optionally along the given dimensions.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part was actually incorrect (out of date).

StefanKarpinski
StefanKarpinski requested changes Feb 28, 2019
View reviewed changes
Copy link
Member

@StefanKarpinski StefanKarpinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to change a lot more instances of v to itr for this to be a consistent change. I suggested a few of them but there were more so I stopped after a while. Note that the "equivalent code" looks a bit weird since length(itr) is not generally a thing you can do for an iterable.

@nalimilan
Fixes
eaccc0c 
[ci skip]
@nalimilan
Copy link
Member Author

Woops, sorry, that's the kind of change that sounds trivial but ends up requiring more though. I've added "For arrays, this is equivalent to" and avoided using length where it can be described using words.

StefanKarpinski
StefanKarpinski approved these changes Feb 28, 2019
View reviewed changes
Copy link
Member

@StefanKarpinski StefanKarpinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now.

@fredrikekre fredrikekre merged commit a3a36c8 into master Mar 1, 2019
@fredrikekre fredrikekre deleted the nl/stdvar branch March 1, 2019 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StefanKarpinski StefanKarpinski StefanKarpinski approved these changes

Assignees
No one assigned
Labels
docs This change adds or pertains to documentation stdlib Julia's standard library
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nalimilan @StefanKarpinski @fredrikekre