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 #15803

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

NedJWestern
Copy link
Contributor

No description provided.

@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

See #13161

Copy link

codecov bot commented Apr 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.35%. Comparing base (0c37ead) to head (43ac306).
Report is 37 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15803      +/-   ##
==========================================
+ Coverage   80.39%   81.35%   +0.95%     
==========================================
  Files        1264     1385     +121     
  Lines      165421   176977   +11556     
  Branches        0     3033    +3033     
==========================================
+ Hits       132994   143971   +10977     
- Misses      32427    32520      +93     
- Partials        0      486     +486     
Flag Coverage Δ
python 74.73% <ø> (?)
rust 78.48% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

Thanks for the PR. It would be good to have examples of the various exceptions.

Currently, the examples aren't running. Could you update accordingly?

Comment on lines 78 to 79
Example
-------
Copy link
Member

@stinodego stinodego Apr 24, 2024

Choose a reason for hiding this comment

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

The sections must be "Examples" rather than "Example". This is important, because otherwise the examples won't run. Could you update all the docstrings in this module accordingly? We may have to skip or use ellipsis (...) here because we will want to omit the traceback.

Suggested change
Example
-------
Examples
--------

@NedJWestern NedJWestern marked this pull request as draft April 24, 2024 23:46
@NedJWestern
Copy link
Contributor Author

Oops, my mistake. That explains why the examples didn't seem to run. All docstrings in this module have been updated.

@NedJWestern NedJWestern marked this pull request as ready for review April 25, 2024 00:56
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