← Back to branch summary

~rackspace-titan/nova/openstack-api-version-split

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: termie
  • Date: 2011-02-12 21:30:31 UTC
  • mto: This revision was merged to the branch mainline in revision 686.
  • Revision ID: github@anarkystic.com-20110212213031-48pp3gmnaf0hfjal
fix :returns: and add pep-0257

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
57
57
  parameters and return types use the Sphinx format. After that an extra
58
58
  newline then close the quotations.
59
59
 
 
60
  When writing the docstring for a class, an extra line should be placed
 
61
  after the closing quotations. For more in-depth explanations for these
 
62
  decisions see http://www.python.org/dev/peps/pep-0257/
 
63
 
60
64
  :param foo: the foo parameter
61
65
  :param bar: the bar parameter
62
 
  :rtype: the return type
 
66
  :returns: description of the return value
63
67
 
64
68
  """