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

Move math docs out of HelpDB, more examples, fix typos #17791

Merged
merged 7 commits into from
Aug 5, 2016
Merged

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Aug 3, 2016

Found a series of typos in cov and friends. Added more notes
about NaN and Julia. Made the function signatures reflect
what's actually in the code. More examples for quite a few
functions.

@kshyatt kshyatt added docs This change adds or pertains to documentation maths Mathematical functions labels Aug 3, 2016
@kshyatt kshyatt force-pushed the ksh/docmath branch 2 times, most recently from 190c43c to 34c839f Compare August 3, 2016 21:28
0.815096 0.36539 0.949436
0.682085 0.179069 0.198193
```
"""
function hcat{T}(V::Vector{T}...)
Copy link
Contributor

Choose a reason for hiding this comment

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

this is only for vectors, the docstring is more general

@tkelman
Copy link
Contributor

tkelman commented Aug 4, 2016

Should all the recommendations about DataArrays be changed to recommend NullableArrays now?

@kshyatt
Copy link
Contributor Author

kshyatt commented Aug 4, 2016

Should all the recommendations about DataArrays be changed to recommend NullableArrays now?

cc: @johnmyleswhite @davidagold

@johnmyleswhite
Copy link
Member

Let's change that after DataFrames changes to use NullableArrays. As it stands, we're in a weird intermediate state in which there's no clear standard.

kshyatt added 7 commits August 4, 2016 23:30
Found a series of typos in `cov` and friends. Added more notes
about `NaN` and Julia. Made the function signatures reflect
what's actually in the code. More examples for quite a few
functions.
Removed calls to `rand` in doctests. Made examples
better. Cleaned up function signatures.
@kshyatt kshyatt merged commit 2d24eda into master Aug 5, 2016
@kshyatt kshyatt deleted the ksh/docmath branch August 5, 2016 15:28
tkelman pushed a commit that referenced this pull request Aug 11, 2016
* Move math docs out of HelpDB, more examples, fix typos

Found a series of typos in `cov` and friends. Added more notes
about `NaN` and Julia. Made the function signatures reflect
what's actually in the code. More examples for quite a few
functions.

* Move quadgk docs out, update formatting

* Moved special functions out of HelpDB, insert some links

* Updated docs for some array ops as well

* Updated in response to feedback

Removed calls to `rand` in doctests. Made examples
better. Cleaned up function signatures.

(cherry picked from commit 2d24eda)
mfasi pushed a commit to mfasi/julia that referenced this pull request Sep 5, 2016
* Move math docs out of HelpDB, more examples, fix typos

Found a series of typos in `cov` and friends. Added more notes
about `NaN` and Julia. Made the function signatures reflect
what's actually in the code. More examples for quite a few
functions.

* Move quadgk docs out, update formatting

* Moved special functions out of HelpDB, insert some links

* Updated docs for some array ops as well

* Updated in response to feedback

Removed calls to `rand` in doctests. Made examples
better. Cleaned up function signatures.
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 maths Mathematical functions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants