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): Improve DataFrame.write_database docstring #19189

Merged
merged 2 commits into from
Oct 14, 2024

Conversation

rodrigogiraoserrao
Copy link
Collaborator

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Oct 11, 2024
Copy link

codecov bot commented Oct 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.95%. Comparing base (44cf3ad) to head (638579a).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #19189   +/-   ##
=======================================
  Coverage   79.94%   79.95%           
=======================================
  Files        1526     1526           
  Lines      208499   208499           
  Branches     2416     2416           
=======================================
+ Hits       166692   166700    +8     
+ Misses      41259    41251    -8     
  Partials      548      548           

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

* "adbc" - inserts using the ADBC cursor's `adbc_ingest` method.
Additional options to pass to the insert method associated with the engine
specified by the option `engine`.
See the documentation for the appropriate method:
Copy link
Collaborator

@alexander-beedie alexander-beedie Oct 12, 2024

Choose a reason for hiding this comment

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

I'd omit line 3895 ("see the documentation") - the reader is already in the documentation (not the documentation of the adbc/alchemy projects, but this suggestion doesn't link to those). But good improvement otherwise :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I actually think that that sentence is important because it makes it obvious to the user that there is an extra level of indirection (see the docs for “the appropriate method”) that they need to follow for the full info.
Either way, I deleted that sentence in 638579a.

@alexander-beedie alexander-beedie merged commit d52e13e into pola-rs:main Oct 14, 2024
13 checks passed
@rodrigogiraoserrao rodrigogiraoserrao deleted the write_database-docs branch October 15, 2024 10:45
@rodrigogiraoserrao rodrigogiraoserrao self-assigned this Oct 15, 2024
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.

Docs: DataFrame.write_database() "engine" param options listed under "engine_options" param
2 participants