diff options
Diffstat (limited to 'docs/internals/contributing/writing-code')
| -rw-r--r-- | docs/internals/contributing/writing-code/coding-style.txt | 12 |
1 files changed, 2 insertions, 10 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index c87e28cda8..dd0d334072 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -40,21 +40,13 @@ Python style from django.views.generic.base import View -* In docstrings, use "action words" such as:: - - def foo(): - """ - Calculates something and returns the result. - """ - pass - - Here's an example of what not to do:: +* In docstrings, follow :pep:`257`. For example:: def foo(): """ Calculate something and return the result. """ - pass + ... Template style -------------- |