-
Notifications
You must be signed in to change notification settings - Fork 4
docs: documentation review changes #483
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
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.
From the changes I've seen associated to docstring / ruff, a title shouldn't be conjugated but being imperative. For example
"""Convert a given ...""" instead of """Converts a given ..."""
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
@echambla i think we might want to add these changes after we have merged my branch than you will get errors on pre-commit. |
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
The towncrier template has been successfully rewritten with the default template. |
Description
Please provide a brief description of the changes made in this pull request.
Issue linked
Please mention the issue number or describe the problem this pull request addresses.
Checklist
feat: add optical property
)