8000 DOC: clarify that np.absolute == np.abs by darcymeyer · Pull Request #10220 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

DOC: clarify that np.absolute == np.abs #10220

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
Merged
merged 2 commits into from
Dec 22, 2017
Merged

DOC: clarify that np.absolute == np.abs #10220

merged 2 commits into from
Dec 22, 2017

Conversation

darcymeyer
Copy link
Contributor

See #9841

eric-wieser
eric-wieser reviewed Dec 15, 2017
View reviewed changes
numpy/core/code_generators/ufunc_docstrings.py Outdated
@@ -41,7 +41,7 @@ def add_newdoc(place, name, doc):

add_newdoc('numpy.core.umath', 'absolute',
"""
Calculate the absolute value element-wise.
Calculate the absolute value element-wise. Equivalent to ``numpy.abs``.
Copy link
Member

Choose a reason for hiding this comment

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

I think np.abs is better than numpy.abs.

I'd put this in another paragraph, since the first line should be a simple summary. Something like "np.abs is a shorthand for this function."

Copy link
Member

Choose a reason for hiding this comment

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

I've made that change, but feel free to git push -f over if if you can think of something better.

I'll squash the commits when I merge

@charris
Copy link
Member
charris commented Dec 19, 2017

"Alias" might be a better word than "shorthand". But otherwise LGTM.

@charris charris merged commit 4655d5b into numpy:master Dec 22, 2017
@charris
Copy link
Member
charris commented Dec 22, 2017

Thanks @darcymeyer .

@matheusportela matheusportela mentioned this pull request Jan 19, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eric-wieser eric-wieser eric-wieser left review comments

Assignees
No one assigned
Labels
04 - Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@darcymeyer @charris @eric-wieser
0