summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code/coding-style.txt
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-01-29 12:21:44 -0500
committerTim Graham <timograham@gmail.com>2015-01-29 12:21:44 -0500
commit63412262e54b4814fe115502bebded9c9993b6f7 (patch)
treedcd83ad031798f257bb9e901e71b5a891bf571cf /docs/internals/contributing/writing-code/coding-style.txt
parent18f3e79b13947de0bda7c985916d5a04e28936dc (diff)
Fixed #24175 -- Updated docstring convention.
Diffstat (limited to 'docs/internals/contributing/writing-code/coding-style.txt')
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt12
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
--------------