Add docstring to the existing framework part
Registered by
Michael Xin
We need to add docstring to the existing framework part using RST format. So that we can generate better documentation.
We should also use the docstrings to populate our Sphinx documentation using autodoc.
Blueprint information
- Status:
- Started
- Approver:
- Matt Valdes
- Priority:
- Medium
- Drafter:
- Michael Xin
- Direction:
- Approved
- Assignee:
- Charles Neill
- Definition:
- Approved
- Series goal:
- None
- Implementation:
-
Good progress
- Milestone target:
- None
- Started by
- Charles Neill
- Completed by
Related branches
Related bugs
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Updating doc strings for core pieces of Syntribos
Addressed by: https:/
Docstrings for more Syntribos components
Addressed by: https:/
Change license from block quotes to '#'s (Sphinx)
(?)
