mirror of https://github.com/django/django.git
[1.11.x] Fixed #27963 -- Removed unneeded docstring example in contributing docs.
Backport of 1e93210f1f
from master
This commit is contained in:
parent
2bd152b46f
commit
98f8e800dd
|
@ -39,13 +39,7 @@ Python style
|
||||||
* Use ``InitialCaps`` for class names (or for factory functions that
|
* Use ``InitialCaps`` for class names (or for factory functions that
|
||||||
return classes).
|
return classes).
|
||||||
|
|
||||||
* In docstrings, follow :pep:`257`. For example::
|
* In docstrings, follow the style of existing docstrings and :pep:`257`.
|
||||||
|
|
||||||
def foo():
|
|
||||||
"""
|
|
||||||
Calculate something and return the result.
|
|
||||||
"""
|
|
||||||
...
|
|
||||||
|
|
||||||
* In tests, use :meth:`~django.test.SimpleTestCase.assertRaisesMessage` instead
|
* In tests, use :meth:`~django.test.SimpleTestCase.assertRaisesMessage` instead
|
||||||
of :meth:`~unittest.TestCase.assertRaises` so you can check the exception
|
of :meth:`~unittest.TestCase.assertRaises` so you can check the exception
|
||||||
|
|
Loading…
Reference in New Issue