Improve documentation
Registered by
Garth Wells
Documentation (for getting users started faster with less problems):
- Improve operator docstrings (use epydoc @param and @return for the more complicated functions)
- Improve manual
Blueprint information
- Status:
- Complete
- Approver:
- None
- Priority:
- Low
- Drafter:
- None
- Direction:
- Needs approval
- Assignee:
- None
- Definition:
- Obsolete
- Series goal:
- None
- Implementation:
- Unknown
- Milestone target:
- None
- Started by
- Completed by
- Martin Sandve Alnæs
Related branches
Related bugs
Sprints
Whiteboard
Docstrings did get an overhaul last year, and the book + paper should be sufficient. The manual is in bad shape but not sure if that will be a priority.
(?)