API Documentation
Registered by
Brian Curtin
Thorough documentation is a necessary part of an SDK. All APIs should be fully documented, from the parameters, to a description of use, to return types and values, and potential exceptions to be raised.
Blueprint information
- Status:
- Complete
- Approver:
- Terry Howe
- Priority:
- Essential
- Drafter:
- Brian Curtin
- Direction:
- Needs approval
- Assignee:
- Terry Howe
- Definition:
- Approved
- Series goal:
- Accepted for master
- Implementation:
-
Implemented
- Milestone target:
- None
- Started by
- Terry Howe
- Completed by
- Terry Howe
Related branches
Related bugs
Sprints
Whiteboard
We are using sphinx autodoc so that the docstrings from the classes can be reused in the documentation.
(?)
