Skip to content
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

docs(python): Fix markdown newline for rendering function description in VSCode #14567

Merged
merged 2 commits into from
Feb 17, 2024

Conversation

CBell045
Copy link
Contributor

Hi,

I noticed on pl.read_csv that the tooltip documentation needed a newline after a list to be formatted correctly.

As you can see in the picture below, all of the attributes after missing_utf8_is_empty_string are listed under the Dict[str, str] bullet point.

Screenshot 2024-02-17 at 2 41 30 PM

It's just a small fix. This is my first time contributing so hopefully this is helpful!

@stinodego stinodego changed the title Fix markdown newline for rendering function description in VSCode docs: Fix markdown newline for rendering function description in VSCode Feb 17, 2024
@stinodego stinodego changed the title docs: Fix markdown newline for rendering function description in VSCode docs(python): Fix markdown newline for rendering function description in VSCode Feb 17, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Feb 17, 2024
Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

You're right, I was not aware of this. We should probably include a blank line in these cases. Thanks!

@stinodego stinodego merged commit b50831a into pola-rs:main Feb 17, 2024
14 of 15 checks passed
@CBell045 CBell045 deleted the doc-bug branch February 17, 2024 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants