You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
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.
Ruff does dosctring linting, it is being implemented in movement
[EDIT] see below PR for movement implementation
The text was updated successfully, but these errors were encountered: