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

Merged
merged 2 commits into from
Dec 22, 2017
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de7e99d
DOC: clarify that np.absolute == np.abs
darcymeyer Dec 15, 2017
133d434
DOC: Rephrase np.absolute docs
eric-wieser Dec 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
DOC: clarify that np.absolute == np.abs 
See #9841
  • Loading branch information
@darcymeyer
darcymeyer committed Dec 15, 2017
commit de7e99df33b51021f1bae8df4eec3f8cc259a3e5
2 changes: 1 addition & 1 deletion numpy/core/code_generators/ufunc_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


Parameters
----------
Expand Down
0