-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Conversation
There was a problem hiding this 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.
@stinodego I'm going to add a few more config examples in if that's ok. Will update in the next couple of days |
@stinodego This is ready for review again. In addition to the earlier docstrings:
|
f4d7c7f
to
28b397d
Compare
There was a problem hiding this 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.
Sure, this did get out of hand |
bc1a706
to
1619420
Compare
There was a problem hiding this 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!
8a28315
to
1f938b2
Compare
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. |
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.