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): Various improvements to docstrings and user guide #10981

Closed
wants to merge 37 commits into from

Conversation

braaannigan
Copy link
Collaborator

@braaannigan braaannigan commented Sep 7, 2023

Closes #10974

As per #10974 the API docs for low_memory could explain a bit more what they do but also direct anyone looking at this to streaming.

The docs for some lazyframe methods have been expanded on to give a bit more info about streaming and related useful methods.

@stinodego stinodego changed the title Streaming and low memory docstrings docs(python): Streaming and low memory docstrings Sep 7, 2023
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Sep 7, 2023
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.

Thanks for the PR. Not 100% sure about the wording here and there - I'll take another look tomorrow and make some minor amendments.

py-polars/polars/lazyframe/frame.py Show resolved Hide resolved
@braaannigan
Copy link
Collaborator Author

@stinodego I'm going to add a few more config examples in if that's ok. Will update in the next couple of days

@braaannigan
Copy link
Collaborator Author

@stinodego This is ready for review again. In addition to the earlier docstrings:

@stinodego stinodego changed the title docs(python): Streaming and low memory docstrings docs(python): Various improvements to docstrings and user guide Oct 6, 2023
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.

Thanks for the all the work here!

I looked at the docstrings - I made some adjustments and I have some some comments, please have a look.

I will now look at the user guide changes.

In the future, please break up your work into smaller PRs. That helps me review things more quickly.

py-polars/polars/config.py Show resolved Hide resolved
py-polars/polars/io/csv/functions.py Outdated Show resolved Hide resolved
py-polars/polars/config.py Outdated Show resolved Hide resolved
py-polars/polars/io/parquet/functions.py Show resolved Hide resolved
@braaannigan
Copy link
Collaborator Author

Thanks for the all the work here!

I looked at the docstrings - I made some adjustments and I have some some comments, please have a look.

I will now look at the user guide changes.

In the future, please break up your work into smaller PRs. That helps me review things more quickly.

Sure, this did get out of hand

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.

A few comments on the user guide part as well.

Definitely some good stuff here, much improved from how it was before!

docs/user-guide/io/database.md Outdated Show resolved Hide resolved
docs/user-guide/io/json_file.md Outdated Show resolved Hide resolved
docs/user-guide/io/parquet.md Outdated Show resolved Hide resolved
docs/_build/API_REFERENCE_LINKS.yml Show resolved Hide resolved
@stinodego
Copy link
Member

stinodego commented Oct 10, 2023

Hm, all the improvements that I had pushed seem to have been overwritten...

I'm going to re-open this PR myself in two parts (docstrings & user guide) and copy the stuff in here.

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.

Better explanation for low_memory
2 participants