DOC: Add example to amax docstring #24676
Closed
Conversation
This file contains hidden or 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
eendebakpt
reviewed
Sep 9, 2023
numpy/core/fromnumeric.py
Outdated
| -------- | ||
| >>> np.amax([4]) | ||
| 4 | ||
| >>> np.amax([4,-1, 67, 89]) |
There was a problem hiding this comment.
Suggested change
| >>> np.amax([4,-1, 67, 89]) | |
| >>> np.amax([4, -1, 67, 89]) |
numpy/core/fromnumeric.py
Outdated
| 4 | ||
| >>> np.amax([4,-1, 67, 89]) | ||
| 89 | ||
| >>> np.amax([[1,2,3,46,44],[2,3,4,55,5]], axis=0) |
There was a problem hiding this comment.
Suggested change
| >>> np.amax([[1,2,3,46,44],[2,3,4,55,5]], axis=0) | |
| >>> np.amax([[1, 2, 3, 46, 44], [2, 3, 4, 55, 5]], axis=0) |
I prefer the example to follow pep8. (not sure this is required, but the example at https://numpydoc.readthedocs.io/en/latest/format.html#examples follows the style as well)
|
@eendebakpt I have made the required changes. |
eendebakpt
approved these changes
Sep 10, 2023
numpy/core/fromnumeric.py
Outdated
| 89 | ||
| >>> np.amax([[1, 2, 3, 46, 44],[2, 3, 4, 55, 5]], axis=0) | ||
| array([2, 3, 4, 55, 44]) | ||
| >>> np.amax([[1, 2, 3, 46, 44],[2, 3, 4, 55, 5]], axis=1) |
There was a problem hiding this comment.
Suggested change
| >>> np.amax([[1, 2, 3, 46, 44],[2, 3, 4, 55, 5]], axis=1) | |
| >>> np.amax([[1, 2, 3, 46, 44], [2, 3, 4, 55, 5]], axis=1) |
|
@eendebakpt I made the suggested change. |
rossbar
reviewed
Sep 12, 2023
|
@rossbar Alright. |
|
Thanks @ankur0904 , I'll go ahead and close this. |
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 example to the
amaxfunction offromnumeric.py. #22266@InessaPawson Please have a look.