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): Add docstring examples for Exceptions #15800

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

NedJWestern
Copy link
Contributor

@NedJWestern NedJWestern commented Apr 20, 2024

See #13161. Some more simple docstring examples for Python Exceptions.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Apr 20, 2024
@NedJWestern
Copy link
Contributor Author

I'm not sure about the PolarsPanicError example. Is this expected?

Copy link

codecov bot commented Apr 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.40%. Comparing base (0c37ead) to head (bbc5562).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #15800   +/-   ##
=======================================
  Coverage   80.39%   80.40%           
=======================================
  Files        1264     1264           
  Lines      165421   165421           
=======================================
+ Hits       132994   132999    +5     
+ Misses      32427    32422    -5     

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

@NedJWestern NedJWestern changed the title docs(python): Add docstring examples for Exceptions (#13161) docs(python): Add docstring examples for Exceptions Apr 21, 2024
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.

See my comment on the other PR. The section must be Examples rather than Example.

@stinodego
Copy link
Member

I'm not sure about the PolarsPanicError example. Is this expected?

We shouldn't include an example for PolarsPanicError. The user should never see it (ideally). You could add some text to the docstring to please open a GitHub issue if they encounter it.

@NedJWestern NedJWestern marked this pull request as draft April 29, 2024 12:46
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.

None yet

2 participants