#19907: Better docstrings with parameter and return information
-------------------------------+----------------------
Reporter: tga | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: master
Severity: Normal | Keywords: comments
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+----------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/19907>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
For more options, visit https://groups.google.com/groups/opt_out.
