Skip to content

DOC: Fix formatting issue with DataFrame.info docs #50816

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 1 commit into from
Jan 18, 2023
Merged

DOC: Fix formatting issue with DataFrame.info docs #50816

merged 1 commit into from
Jan 18, 2023

Conversation

CarlosGDCJ
Copy link
Contributor

Removed a backslash that was causing the description of the max_cols argument from the DataFrme.info method to be merged with the description of the buf argument.
image

Removed backslash that was causing the description of two function arguments to be merged together
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Thanks @CarlosGDCJ, nice catch.

Before we merge, can you check at the rendered docs if the documentation for Series.info and DataFrame.info is rendered as expected after this change?

You can build the docs online, or in the CI there should be an artifact with the whole website/docs built, that you can download and check locally.

Thanks!

@CarlosGDCJ
Copy link
Contributor Author

Sure. I downloaded the CI artifact and checked the HTML. Everything seems fine with DataFrame.info:
image

Series.info also looks ok (I get the same HTML as the live site)

@datapythonista
Copy link
Member

Excellent, thanks @CarlosGDCJ. I'm re-running the CI job that failed. I think the failure is unrelated, but just to be sure.

@mroeschke mroeschke added this to the 2.0 milestone Jan 18, 2023
@mroeschke mroeschke merged commit 3ec3ac2 into pandas-dev:main Jan 18, 2023
@mroeschke
Copy link
Member

Thanks @CarlosGDCJ

@CarlosGDCJ CarlosGDCJ deleted the patch-1 branch January 18, 2023 19:33
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.

3 participants