Consider adding docstrings to Python implementation
Open
- Dominant language
- C++
- Stars
- 16.7k
- Forks
- 1.6k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 126
Description
Currently, static analysis tools can't provide the user with inline documentation because there are very few docstrings in the Python implementation. These hints would be immensely helpful to speed up development.
We could move the existing `api-python.rst` documentation to inline docstrings, and then use the Sphinx `autodoc` plugin to generate it.
Alternatively, there may be a may to keep `api-python.rst` as the source of truth, parse out method names, and then write the associated docs to the implementation files. However, there are no tools I found that do this already, so it'd be more complex.
Contributor guide
Assessment
This issue has not been assessed yet.