#25159: Remove brackets from method/function signatures in docs
------------------------------------------------+------------------------
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Keywords:
Triage Stage: Accepted | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
According to the [http://sphinx-
doc.org/domains.html?highlight=function#signatures spinx docs], "For
functions with optional parameters that don’t have default values
(typically functions implemented in C extension modules without keyword
argument support), you can use brackets to specify the optional parts".
Not sure how our docs got in the habit of using brackets, but it doesn't
seem like we should be doing that.
Brackets should be removed from things like:
`.. function:: create_test_db([verbosity=1, autoclobber=False,
serialize=True, keepdb=False])`
and missing kwarg defaults should be added in places like:
`.. function:: password_reset_confirm(request[, uidb64, token,
template_name, token_generator, set_password_form, post_reset_redirect,
current_app, extra_context])`
Find the places to update with `grep -rI "\[" * | grep 'function::'` and
`grep -rI "\[" * | grep 'method::'`.
--
Ticket URL: <https://code.djangoproject.com/ticket/25159>
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].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/052.633b8a1705896739a8c896f8564df60c%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
