mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-03 02:23:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Refs #27392 -- Removed "Tests that", "Ensures that", etc. from test docstrings.

Browse source
This commit is contained in:
za 2016-10-27 14:53:39 +07:00 • committed by Tim Graham
parent 4bb70cbcc6
commit 321e94fa41
185 changed files with 1216 additions and 1528 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/internals/contributing/writing-code/coding-style.txt
View file

@ -53,6 +53,19 @@ Python style
(``six.assertRaisesRegex()`` as long as we support Python 2) only if you need
to use regular expression matching.
* In test docstrings, state the expected behavior that each test demonstrates.
Don't include preambles such as "Tests that" or "Ensures that".
Reserve ticket references for obscure issues where the ticket has additional
details that can't be easily described in docstrings or comments. Include the
ticket number at the end of a sentence like this::
def test_foo():
"""
A test docstring looks like this (#123456).
"""
...
.. _coding-style-imports:
Imports