Skip to content

DOC: sphinx doc list item text has strange bold effect #43937

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

Closed
1 task done
Zeroto521 opened this issue Oct 9, 2021 · 2 comments · Fixed by #43955 or #43964
Closed
1 task done

DOC: sphinx doc list item text has strange bold effect #43937

Zeroto521 opened this issue Oct 9, 2021 · 2 comments · Fixed by #43955 or #43964
Labels
Docs replace replace method
Milestone

Comments

@Zeroto521
Copy link
Contributor

Zeroto521 commented Oct 9, 2021

  • I have checked that the issue still exists on the latest versions of the docs on master here

Location of the documentation

Documentation problem

As title.

image

Suggested fix for documentation

In using sphinx experience, the following could fix that.
Note that numeric and replaced have the same indent level.

            - numeric: numeric values equal to `to_replace` will be
-                replaced with `value`
+              replaced with `value`
- numeric: numeric values equal to `to_replace` will be
  replaced with `value`  

My local test result.

image

@Zeroto521 Zeroto521 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 9, 2021
@Zeroto521 Zeroto521 changed the title DOC: DOC: sphinx doc list item strange bold effect Oct 9, 2021
@Zeroto521 Zeroto521 changed the title DOC: sphinx doc list item strange bold effect DOC: sphinx doc list item text has strange bold effect Oct 9, 2021
@mzeitlin11
Copy link
Member

Thanks for reporting this @Zeroto521! I agree your fix looks better - would you be interested in making a pr?

@mzeitlin11 mzeitlin11 added replace replace method and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 9, 2021
@mzeitlin11 mzeitlin11 added this to the Contributions Welcome milestone Oct 9, 2021
@Zeroto521
Copy link
Contributor Author

I'd like to do it. I will fix replace's doc at later time.
This problem doesn't just happen on one place, I have seen several places.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs replace replace method
Projects
None yet
3 participants