Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

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

git-svn-id: http://code.djangoproject.com/svn/django/trunk@5765 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 812583ce3b49ec871ded8d281a80ac6809f8df44 1 parent 29078ea
Adrian Holovaty adrianholovaty authored
Showing with 16 additions and 0 deletions.
  1. +16 −0 docs/contributing.txt
16 docs/contributing.txt
View
@@ -279,6 +279,22 @@ Please follow these coding standards when writing code for inclusion in Django:
* 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
keep contributors' names in the ``AUTHORS`` file distributed with Django
-- not scattered throughout the codebase itself. Feel free to include a
Please sign in to comment.
Something went wrong with that request. Please try again.