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
There are a number of different styles of docstrings for various classes... or none at all. These lead to a lot of warnings in the docs builds, where some of the choices clash with being presented (usefully) with many on a page.
Suggested Improvement
Normalize on a single docstring style which gives:
good documentation when rendered in sphinx
good in-client UI when rendered in IPython inspector, JupyterLab, Language Servers, etc.
Add best-effort type hints
these work great in sphinx these days
strictly better than "low content" parameters tables that give minimal information beyond typing
Maybe add some docstring formatting/style/spelling checkers
Maybe add/update custom inspect.Signature that does a better job of reusing the above
Maybe write some sphinx transformers to make repetitive headers (e.g. examples, parameters) more useful
Problem
There are a number of different styles of docstrings for various classes... or none at all. These lead to a lot of warnings in the docs builds, where some of the choices clash with being presented (usefully) with many on a page.
Suggested Improvement
parameters
tables that give minimal information beyond typinginspect.Signature
that does a better job of reusing the aboveexamples
,parameters
) more usefulReferences
The text was updated successfully, but these errors were encountered: