Skip to content

Conversation

@AndreasAlbertQC
Copy link
Collaborator

@AndreasAlbertQC AndreasAlbertQC commented Oct 20, 2025

Motivation

Polishing.

Changes

  • Added intersphinx support so we can link to other projects properly.
  • Wherever applicable, I fixed up class/method/function references to render as hyperlinks
  • Added the napoleon extension 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 docstrings
  • Removed outdated docstring references to the mypy plugin

Note: you cannot currently link to polars.DataFrame and polars.LazyFrame, which seems to be a problem in the polars doc 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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 20, 2025
@AndreasAlbertQC AndreasAlbertQC marked this pull request as ready for review October 20, 2025 12:19
@codecov
Copy link

codecov bot commented Oct 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (4c2bac7) to head (c82f0a3).
⚠️ Report is 6 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@borchero borchero left a 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? 😄

@AndreasAlbertQC AndreasAlbertQC merged commit dceef96 into main Oct 20, 2025
24 checks passed
@AndreasAlbertQC AndreasAlbertQC deleted the cleanup branch October 20, 2025 14: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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants