Skip to content

DOC: Fix Series nlargest and nsmallest doc strings (#43964) #43964

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

Merged
merged 5 commits into from
Oct 12, 2021
Merged

DOC: Fix Series nlargest and nsmallest doc strings (#43964) #43964

merged 5 commits into from
Oct 12, 2021

Conversation

Zeroto521
Copy link
Contributor

@Zeroto521 Zeroto521 commented Oct 11, 2021

From
Clip_20211011_094600
To
Clip_20211011_105541

Copy link
Contributor

@attack68 attack68 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@alimcmaster1 alimcmaster1 added this to the 1.4 milestone Oct 12, 2021
@alimcmaster1
Copy link
Member

Thanks @Zeroto521 - LGTM.

Could you also fix or create a follow up issue for DataFrame.nlargest - look inconsistent with others backticks are not correct around the first args: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.nlargest.html

- `first` : prioritize the first occurrence(s)

@alimcmaster1 alimcmaster1 changed the title DOC: cancel nlargest and nsmallest's doc list item text bold effect DOC: Fix Series nlargest and nsmallest doc strings (#43964) Oct 12, 2021
@alimcmaster1 alimcmaster1 merged commit b80f8ef into pandas-dev:master Oct 12, 2021
@Zeroto521 Zeroto521 deleted the cancel-bold branch October 13, 2021 00:48
@Zeroto521
Copy link
Contributor Author

Could you also fix or create a follow up issue for DataFrame.nlargest - look inconsistent with others backticks are not correct around the first args: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.nlargest.html

Do you mean to add double backticks for first and last, like the following?

-           - `first` : prioritize the first occurrence(s)
-           - `last` : prioritize the last occurrence(s)
+           - ``first`` : prioritize the first occurrence(s)
+           - ``last`` : prioritize the last occurrence(s)
            - ``all`` : do not drop any duplicates, even it means
              selecting more than `n` items.

@alimcmaster1
Copy link
Member

Could you also fix or create a follow up issue for DataFrame.nlargest - look inconsistent with others backticks are not correct around the first args: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.nlargest.html

Do you mean to add double backticks for first and last, like the following?

-           - `first` : prioritize the first occurrence(s)
-           - `last` : prioritize the last occurrence(s)
+           - ``first`` : prioritize the first occurrence(s)
+           - ``last`` : prioritize the last occurrence(s)
            - ``all`` : do not drop any duplicates, even it means
              selecting more than `n` items.

Yes exactly so they are consistent with the docs here :) @Zeroto521

@Zeroto521
Copy link
Contributor Author

@alimcmaster1 see #44040

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: sphinx doc list item text has strange bold effect
3 participants