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: Document DataFrame.__getitem__ and Series.__getitem__ #18309

Merged
merged 1 commit into from
Aug 22, 2024

Conversation

MarcoGorelli
Copy link
Collaborator

I was adding docs for these in Narwhals and noticed they don't appear in the Polars docs. Let's add them!

@@ -8,6 +8,7 @@ Export DataFrame data to other formats:
.. autosummary::
:toctree: api/

DataFrame.__array__
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

drive-by

Comment on lines 20 to +21
- `memory_resource`: Set an RMM memory resource for
device-side allocations.
device-side allocations.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

same

@MarcoGorelli MarcoGorelli changed the title docs: document DataFrame.__getitem__ and Series.__getitem__ docs: Document DataFrame.__getitem__ and Series.__getitem__ Aug 22, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars and removed title needs formatting labels Aug 22, 2024
@MarcoGorelli MarcoGorelli marked this pull request as ready for review August 22, 2024 10:04
Copy link

codecov bot commented Aug 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.35%. Comparing base (70459e4) to head (a9ede86).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18309      +/-   ##
==========================================
+ Coverage   80.23%   80.35%   +0.11%     
==========================================
  Files        1501     1501              
  Lines      199180   199214      +34     
  Branches     2837     2837              
==========================================
+ Hits       159822   160076     +254     
+ Misses      38830    38610     -220     
  Partials      528      528              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alexander-beedie
Copy link
Collaborator

alexander-beedie commented Aug 22, 2024

Good idea; there's quite a bit going on in __getitem__ 👍
(FYI: just started looking over the plotting commit ;)

@MarcoGorelli
Copy link
Collaborator Author

cool, thanks for your review! 🙏

@MarcoGorelli MarcoGorelli merged commit 6c4835e into pola-rs:main Aug 22, 2024
15 of 16 checks passed
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 rust Related to Rust Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants