DOC: Update lexsort docstring for axis kwargs #24935
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
liang3zy22
force-pushed
the
lexsortdoc
branch
6 times, most recently
from
37d6834
to
db093ff
Compare
liang3zy22
force-pushed
the
lexsortdoc
branch
2 times, most recently
from
52bcdf6
to
bf7988f
Compare
liang3zy22
force-pushed
the
lexsortdoc
branch
from
bf7988f
to
acd4bcd
Compare
[skip actions][skip cirrus][skip azp] Signed-off-by: Liang Yan <ckgppl_yan@sina.cn>
liang3zy22
force-pushed
the
lexsortdoc
branch
from
acd4bcd
to
20790a8
Compare
[skip azp] [skip actions] [skip cirrus]
|
I don't think this closes gh-10521; but with some adjustments, it would address the documentation part of the issue. I've taken the liberty of implementing my own suggestions for simplification. LMK if this still looks good @liang3zy22. |
[skip cirrus] [skip azp] [skip actions]
|
It looks good, @mdhaber . It made the lexsort doc more clear. I think my change is a tutorial for how to use lexsort and the axis parameter. |
|
Merging. Any more cleanup can be done in a follow-up. Thanks @liang3zy22 and @mdhaber this is a nice improvement. |
mdhaber
reviewed
Jan 16, 2024
| The `k` different "columns" to be sorted. The last column (or row if | ||
| `keys` is a 2D array) is the primary sort key. | ||
| keys : (k, m, n, ...) array-like | ||
| The `k` keys to be sorted. The *last* key (e.g, the last |
There was a problem hiding this comment.
Suggested change
| The `k` keys to be sorted. The *last* key (e.g, the last | |
| The `k` keys to be sorted. The *last* key (e.g., the last |
There was a problem hiding this comment.
No problem, I just meant to go through this one more time. I added that to remind myself to fix it one day, but NBD.
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.
[skip actions][skip cirrus][skip azp]
try to address the docstring part of #10521