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
base: main
Are you sure you want to change the base?
Conversation
See #13161 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this 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?
py-polars/polars/exceptions.py
Outdated
Example | ||
------- |
There was a problem hiding this comment.
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.
Example | |
------- | |
Examples | |
-------- |
Oops, my mistake. That explains why the examples didn't seem to run. All docstrings in this module have been updated. |
No description provided.