diff options
| author | Mikkel Munch Mortensen <3xm@detfalskested.dk> | 2017-03-21 15:12:41 +0100 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-03-21 10:46:03 -0400 |
| commit | 98f8e800dd9a07e896ef2d9f0ce6f3caebf632f4 (patch) | |
| tree | 6c3dfae814c54728229511a5218e3433d5b8667a /docs/internals/contributing/writing-code | |
| parent | 2bd152b46f608933a8c4c6a3c2689781fc58f4fd (diff) | |
[1.11.x] Fixed #27963 -- Removed unneeded docstring example in contributing docs.
Backport of 1e93210f1f622b692dd65e861f0793ac61552d28 from master
Diffstat (limited to 'docs/internals/contributing/writing-code')
| -rw-r--r-- | docs/internals/contributing/writing-code/coding-style.txt | 8 |
1 files changed, 1 insertions, 7 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index fe0a21c5a5..189e7c7426 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -39,13 +39,7 @@ Python style * Use ``InitialCaps`` for class names (or for factory functions that return classes). -* In docstrings, follow :pep:`257`. For example:: - - def foo(): - """ - Calculate something and return the result. - """ - ... +* In docstrings, follow the style of existing docstrings and :pep:`257`. * In tests, use :meth:`~django.test.SimpleTestCase.assertRaisesMessage` instead of :meth:`~unittest.TestCase.assertRaises` so you can check the exception |