DOC: Copy-edit the 'partition' docstring. #22149
Merged
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
|
Link to the rendered updated docstring: partition |
charris
reviewed
Aug 18, 2022
numpy/core/fromnumeric.py
Outdated
| the k-th element are moved before this element and all equal or | ||
| greater are moved behind it. The ordering of the elements in the two | ||
| partitions is undefined. | ||
| position it would be in a sorted array. In the partitioned array, all |
There was a problem hiding this comment.
"it" is a bit ambiguous, the element or its value? I think "value" would be correct, i.e., the same as the value of the k-th element of the sorted array.
There was a problem hiding this comment.
Thanks @charris, I pushed an update. I also fixed kth to k-th to match the existing usage.
There was a problem hiding this comment.
I added a bunch of skip tags in the recent commit message--maybe too many?
[skip actions] [skip travis] [skip azp]
|
Thanks Warren. |
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.
Closes gh-7958.