4 ms·
> the docstrings get out of sync with the actual signature / types of the methods/etc that they purport to document But that's on the devs, not Sphinx, eh?
by carapace 7y ago
> the docstrings get out of sync with the actual signature / types of the methods/etc that they purport to document
But that's on the devs, not Sphinx, eh?
- weberc2 7y agoIt's kind of on the whole dynamically typed model. If you can have static type annotations that are validated for correctness, then you can use those annotations to validate or generate your documentation. Python supports annotations and validation thereof via Mypy, and assuming the project takes advantage of these, then Sphinx could leverage them to validate/generate documentation.