DOC: Add documentation for round and round_ aliases #19906
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
charris
changed the title
Mukulikaa
reviewed
Sep 30, 2021
| @@ -3276,7 +3276,8 @@ def around(a, decimals=0, out=None): | |||
| See Also | |||
| -------- | |||
| ndarray.round : equivalent method | |||
|
|
|||
| numpy.round: equivalent method | |||
There was a problem hiding this comment.
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.
Mukulikaa
reviewed
Sep 30, 2021
| @@ -3276,7 +3276,8 @@ def around(a, decimals=0, out=None): | |||
| See Also | |||
| -------- | |||
| ndarray.round : equivalent method | |||
|
|
|||
| numpy.round: equivalent method | |||
| numpy.round_: equivalent method | |||
There was a problem hiding this comment.
Suggested change
| numpy.round_: equivalent method | |
| round_ : equivalent method |
This is a nit just to maintain consistency with the rest of the documentation.
|
@aparnabushan It would be nice to fix #19717. Do you think you could finish this PR? |
|
I’ve opened a new PR (#21853) to continue the work started here. I’m closing this PR and adding you as my co-authors in the new one. Feel free to contribute to the new PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added docstring for round and round_ as aliases that both refer to around()
This is a fix to the bug - #19717