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): Remove unwanted linebreaks from docstrings #16002

Merged

Conversation

bertiewooster
Copy link
Contributor

@bertiewooster bertiewooster commented May 2, 2024

By changing double backslashes to single backslashes to prevent unwanted linebreak. Fixes #14454. Applies to Series.bottom_k, Series.top_k, Expr.bottom_k and Expr.top_k. I searched the Python and Rust files and did not notice any other instances where this change seemed to be needed.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 2, 2024
@bertiewooster bertiewooster changed the title docs(python):Remove unwanted linebreaks from docstrings docs(python): Remove unwanted linebreaks from docstrings May 2, 2024
@github-actions github-actions bot added the python Related to Python Polars label May 2, 2024
@bertiewooster
Copy link
Contributor Author

I notice that the Rust and Python CI code coverage checks failed; they seem to be for technical reasons, namely a lack of credentials, unrelated to the content of this PR:

Error: Codecov token not found. Please provide Codecov token with -t flag.
Error: Codecov: Failed to properly create commit: The process '/Users/runner/work/_actions/codecov/codecov-action/v4/dist/codecov' failed with exit code 1

@orlp orlp merged commit f03e7e0 into pola-rs:main May 2, 2024
14 of 16 checks passed
@orlp
Copy link
Collaborator

orlp commented May 2, 2024

Thanks for the PR!

@bertiewooster
Copy link
Contributor Author

@orlp thanks for reviewing it so quickly! I notice that the changes are already live on the dev site for polars.Expr.bottom_k, polars.Series.bottom_k, polars.Expr.top_k, and polars.Series.top_k.

I assume the changes will be reflected in the stable site upon the next release for pages polars.Expr.bottom_k, polars.Series.bottom_k, polars.Expr.top_k, and polars.Series.top_k. Which will probably be quite soon given Polars' impressive release pace! ;)

@bertiewooster bertiewooster deleted the double-backslash-to-single-docstrings branch May 3, 2024 04:10
AlexanderNenninger pushed a commit to AlexanderNenninger/polars that referenced this pull request May 3, 2024
@bertiewooster
Copy link
Contributor Author

bertiewooster commented May 8, 2024

Indeed the changes are live on the default docs pages due to the recent release. Great!

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.

Broken docstrings, double backslash -> single backslash
2 participants