Changeset 5765

Timestamp:

07/26/07 12:16:34 (1 year ago)

Author:

adrian

Message:

Added section to docs/contributing.txt about docstring coding style

Files:

• django/trunk/docs/contributing.txt (modified) (1 diff)

django/trunk/docs/contributing.txt

@@ -279 +279 @@
-    * Mark all strings for internationalization; see the `i18n documentation`_
-      for details.
+
+    * In docstrings, use "action words," like so::
+
+          def foo():
+              """
+              Calculates something and returns the result.
+              """
+              pass
+
+      Here's an example of what not to do::
+
+          def foo():
+              """
+              Calculate something and return the result.
+              """
+              pass
-
-    * Please don't put your name in the code you contribute. Our policy is to