Skip to content
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

Add docstring linting #369

Open
JoeZiminski opened this issue Apr 17, 2024 · 2 comments
Open

Add docstring linting #369

JoeZiminski opened this issue Apr 17, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@JoeZiminski
Copy link
Member

JoeZiminski commented Apr 17, 2024

Ruff does dosctring linting, it is being implemented in movement

[EDIT] see below PR for movement implementation

@JoeZiminski
Copy link
Member Author

Also note for code in costrings like " some function" should have double backticks:

"Needs doube backticks to rended as monospace in sphinx. As it is now, the result will be italicised ( I think). Not that it matters much, since this is a private functions." (Niko)

@JoeZiminski
Copy link
Member Author

JoeZiminski commented Jun 9, 2024

In general, the docstrings need a major audit / make a decision on whether to completely omit type hints from docstrings. It is unecessary to include these thanks for sphinx-autodoc-typehints although it will break with numpydoc style (?). There seems to be movement in this direction, and the risk of errors from duplicating the type hint in code and docstring is very high.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant