-
Couldn't load subscription status.
- Fork 13
docs: Clean up small issues in docs #180
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
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #180 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 50 50
Lines 2897 2904 +7
=========================================
+ Hits 2897 2904 +7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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 a lot! Regarding polishing documentation: can we also get rid of the double backticks in the docstrings? 😄
Motivation
Polishing.
Changes
napoleonextension so our doc strings are parsed more robustly. This resolves small styling problems with lists of arguments in docstrings, as well as with Exceptions in docstringsNote: you cannot currently link to
polars.DataFrameandpolars.LazyFrame, which seems to be a problem in thepolarsdoc build, not on our end. You can verify that these classes do not appear in the structured output sphinx uses:pixi run -e docs python -m sphinx.ext.intersphinx https://docs.pola.rs/py-polars/html/objects.inv