Skip to content

Commit

Permalink
Added section to docs/contributing.txt about docstring coding style
Browse files Browse the repository at this point in the history
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5765 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
adrianholovaty committed Jul 26, 2007
1 parent 29078ea commit 812583c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/contributing.txt
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -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`_ * Mark all strings for internationalization; see the `i18n documentation`_
for details. 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 * 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 keep contributors' names in the ``AUTHORS`` file distributed with Django
-- not scattered throughout the codebase itself. Feel free to include a -- not scattered throughout the codebase itself. Feel free to include a
Expand Down

0 comments on commit 812583c

Please sign in to comment.