Idea #18797
Updated by Peter Amstutz over 1 year ago
Determine the capabilities & correct usage of pydoc for * text formatting * annotating function parameters * module-level docstrings * treatment of Py3 type annotations (what does the documentation system do with them, how are they displayed, how does it take advantage of it) Determine how to mark things as deprecated (documentation only, or possibly using decorators somehow) Determine how to hide private variables/functions/classes from documentation (or possibly not export them at all, but need to be careful about backwards compatibility) compatability) Do some initial documentation samples and share with the team for feedback. The end goal is to update *all* documentation for public APIs in the Python SDK with correct formatting, deprecation markers, type annotations, etc. Also module-level docstrings to direct users to the correct classes for various topics. However, documenting everything now is not required for this ticket. You should produce a document with guidelines and best practices for the team for Python SDK documentation going forward.