#25159 closed Cleanup/optimization (fixed)
Remove brackets from method/function signatures in docs
Reported by: | Tim Graham | Owned by: | Tim Graham |
---|---|---|---|
Component: | Documentation | Version: | 1.8 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
According to the 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::'
.
Change History (6)
comment:1 by , 9 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:2 by , 9 years ago
Owner: | removed |
---|---|
Status: | assigned → new |
comment:3 by , 9 years ago
Owner: | set to |
---|---|
Status: | new → assigned |
comment:4 by , 9 years ago
Has patch: | set |
---|
PR