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

Normalize docstring styles, add type hints and traitlets help #3676

Open
bollwyvl opened this issue Jan 24, 2023 · 0 comments
Open

Normalize docstring styles, add type hints and traitlets help #3676

bollwyvl opened this issue Jan 24, 2023 · 0 comments
Labels

Comments

@bollwyvl
Copy link
Contributor

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

  • 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

References

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

No branches or pull requests

1 participant