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

DOC: Add documentation for round and round_ aliases #19906

Closed
wants to merge 1 commit into from
Closed

DOC: Add documentation for round and round_ aliases #19906

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion numpy/core/fromnumeric.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3276,7 +3276,8 @@ def around(a, decimals=0, out=None):
See Also
--------
ndarray.round : equivalent method

numpy.round: equivalent method
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
numpy.round: equivalent method

numpy.round does not exist in the documentation so we cannot add it to the See Also for now. I think a good option would be to write in the Notes that np.round is often used as an alias for np.around. That would potentially clear up any confusion as to why np.round is used in the examples in the Notes section.

numpy.round_: equivalent method
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
numpy.round_: equivalent method
round_ : equivalent method

This is a nit just to maintain consistency with the rest of the documentation.

ceil, fix, floor, rint, trunc


Expand Down