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 bad bullet points #10319

Closed
wants to merge 4 commits into from

Conversation

MarcoGorelli
Copy link
Collaborator

@MarcoGorelli MarcoGorelli commented Aug 6, 2023

Here's a mistake I keep making: writing bullet points in docstrings in a way that won't render

It seems like a common mistake - running this little script I put together, I found the following two cases where the docstring doesn't render as expected:

I couldn't find an existing tool which does this, so put together a little script


Original motivation: #10235 (comment)

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Aug 6, 2023
@MarcoGorelli MarcoGorelli marked this pull request as ready for review August 6, 2023 11:02
Copy link
Contributor

@Fokko Fokko left a comment

Choose a reason for hiding this comment

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

Love it!

@ritchie46
Copy link
Member

@stinodego I'd like to leave this one to you.

@stinodego
Copy link
Member

stinodego commented Aug 11, 2023

I'm not a big fan of custom linting scripts like this. If you do this for every issue you run into, you'll have 100 linting scripts by the end of it.

This did trigger me to take another look at our Sphinx setup, and I've included the docstring fixes in #10400.

I'd say for now let's just pay some extra attention to make sure we don't merge broken docstring RST formatting. Meanwhile, I'm looking into parsing the docstrings as Markdown as a proper solution...

Closing this for now, though discussion is welcome.

@stinodego stinodego closed this Aug 11, 2023
@MarcoGorelli
Copy link
Collaborator Author

Sure, no worries, thanks!

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants