Skip to content

Improve docstrings and type hinting #1588

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

Closed

Conversation

RobinPicard
Copy link
Contributor

The objective of this PR is to globally improve the state of our docstrings and type hints. There are 2 goals:

  • We need to have those (correctly formatted) for the API Reference pages in the documentation to render correctly
  • We want them to be informative such that users consulting the documentation or codebase can easily understand what's going on

I focused on the parts of the codebase that are the mostly likely to be read by our users, so there are some functions/classes for which this is still missing.

@RobinPicard RobinPicard force-pushed the improve_docstrings_typing branch from 1ff9a8e to 55d372c Compare May 27, 2025 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant