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): bring sink_ndjson docstring in line with other sink docstrings #13636

Merged
merged 2 commits into from
Jan 11, 2024

Conversation

henryharbeck
Copy link
Contributor

In #11644 the docstrings for sink methods were updated from

Persists a LazyFrame at the provided path.

to

Evaluate the query in streaming mode and write to a {format} file.

Also, all other sink methods have the slice_pushdown parameter second last and the no_optimization parameter last.

This brings sink_ndjson in line with both of those.

PS: sorry for the tiny PR - hopefully not too spammy

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Jan 11, 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.

Looks great!

I like small PRs, they are quick to review 😄

@stinodego stinodego merged commit ae147e0 into pola-rs:main Jan 11, 2024
15 checks passed
@henryharbeck henryharbeck deleted the ndjson-docstring branch January 11, 2024 13:32
r-brink pushed a commit to r-brink/polars that referenced this pull request Jan 24, 2024
…strings (pola-rs#13636)

Co-authored-by: Henry Harbeck <henry.harbeck@canstar.com.au>
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.

2 participants