#27392: Remove "Tests that", "Ensures that", etc. from test docstings
------------------------------------------------+------------------------
Reporter: Tim Graham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
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 |
------------------------------------------------+------------------------
Our policy is for test docstrings to state the expected behavior that each
test demonstrates. Preambles such as "Tests that" or "Ensures that" aren't
necessary.
Good: "Horizontal and vertical filter widgets keep selected options on
page reload."
Bad: "Tests that horizontal and vertical...".
For example:
$ grep -rI "Tests that" * | wc -l
158
$ grep -rI "Test that" * | wc -l
222
$ grep -rI "Ensure that" * | wc -l
173
$ grep -rI "Ensures that" * | wc -l
14
If you spot any other similar patterns, please correct them. The policy
should also be added to `docs/internals/contributing/writing-code/coding-
style.txt`.
--
Ticket URL: <https://code.djangoproject.com/ticket/27392>
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.24e96db0c67243ea91185e03b04fc352%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
