Project

General

Profile

Story #18797

Updated by Peter Amstutz 7 months ago

Determine the capabilities & correct usage of pydoc for 
 * text formatting 
 * annotating function parameters 
 * module-level docstrings 

 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 compatability) 

 Do some initial documentation samples and share with the team for feedback. 

 The goal is to update *all* Update documentation for public APIs in the Python SDK with correct formatting, deprecation markers, etc.    Also module-level docstrings to direct users to the correct classes for various topics. 

Back