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): Mention row_by_keys in the to_dict documentation #19767

Merged
merged 2 commits into from
Nov 15, 2024

Conversation

gab23r
Copy link
Contributor

@gab23r gab23r commented Nov 13, 2024

User coming from pandas will try to get the equivalent of df.set_index([key1, key2]).to_dict() but can easily miss row_by_keys. I think adding row_by_keys in the "see also" section of to_dict is a good addition

@gab23r gab23r changed the title add see also docs: Mention row_by_keys in the to_dict documentation Nov 13, 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 Nov 13, 2024
Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.56%. Comparing base (8cb7839) to head (cc5ac99).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #19767   +/-   ##
=======================================
  Coverage   79.55%   79.56%           
=======================================
  Files        1544     1544           
  Lines      213240   213240           
  Branches     2441     2441           
=======================================
+ Hits       169643   169658   +15     
+ Misses      43048    43033   -15     
  Partials      549      549           

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

Copy link
Collaborator

@alexander-beedie alexander-beedie left a comment

Choose a reason for hiding this comment

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

Looks like a good addition - while you're at it, could you also add to_dicts to the same "See Also", and then add to_dict to the rows_by_key "See Also" so it goes both ways? :)

@alexander-beedie alexander-beedie changed the title docs: Mention row_by_keys in the to_dict documentation docs(python): Mention row_by_keys in the to_dict documentation Nov 14, 2024
@alexander-beedie alexander-beedie removed the rust Related to Rust Polars label Nov 14, 2024
@gab23r gab23r force-pushed the docs-see-also-rows branch from cc5ac99 to 81034ef Compare November 15, 2024 12:41
@alexander-beedie alexander-beedie merged commit 0e7f07e into pola-rs:main Nov 15, 2024
10 of 12 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants