-
Notifications
You must be signed in to change notification settings - Fork 106
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.
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
SNOW-1458130 Minor documentation fix for Series.sort_values
#1916
SNOW-1458130 Minor documentation fix for Series.sort_values
#1916
Conversation
…to-series-sort-values
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks!
@@ -390,7 +390,9 @@ Methods | |||
| ``sort_index`` | P | | ``N`` if given the ``key`` param. ``N`` if | | |||
| | | | ``axis == 1``, or MultiIndex. | | |||
+-----------------------------+---------------------------------+----------------------------------+----------------------------------------------------+ | |||
| ``sort_values`` | P | | ``N`` if given the ``key`` param or ``axis == 1`` | | |||
| ``sort_values`` | P | ``key`` | ``N`` if given the ``key`` param or ``axis == 1``. | | |||
| | | | Snowpark pandas currently uses stable sort when | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some corrections:
- "when sorting the index values" doesn't seem to apply since this is about
DataFrame
. Anyway, I would delete this fragment because it's redundant. - This description makes it sound like "stable sort" is an algorithm, but it's a description of an algorithm.
- We should mention that Snowpark pandas ignores the
kind
parameter completely. We currently warnchoice of sort algorithm 'quicksort' is ignored. sort kind must be 'stable' or None
.
So I suggest something like
The ``kind`` paramater has no effect. Snowpark pandas always uses a stable sort algorithm, while pandas by default does not.
@@ -379,7 +379,8 @@ Methods | |||
| ``sort_index`` | P | | ``N`` if given the ``key`` param, | | |||
| | | | or MultiIndex | | |||
+-----------------------------+---------------------------------+----------------------------------+----------------------------------------------------+ | |||
| ``sort_values`` | P | | ``N`` if given the ``key`` parameter | | |||
| ``sort_values`` | P | ``key`` | Snowpark pandas currently uses stable sort when | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thank you!
Which Jira issue is this PR addressing? Make sure that there is an accompanying issue to your PR.
Fixes SNOW-1458130
Fill out the following pre-review checklist:
Please describe how your code solves the related issue.
Added missing parameter
key
to the respective column and also add details about how sorting works.