Opened 12 years ago
Last modified 10 years ago
#19907 closed Cleanup/optimization
Better docstrings with parameter and return information — at Initial Version
Reported by: | tga | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | comments |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
Many functions need better parameter documentation in their docstring because without it, it is difficult to understand what's going on.
Bonus points while doing this: use Sphinx style (:param foo: Description).
1) it provides a standard way of writing docstrings,
2) is already in use in docs, and
3) it will also help with IDE support.
Note:
See TracTickets
for help on using tickets.