← Back to branch summary

~sandy-walsh/nova/zones

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Sandy Walsh
  • Date: 2011-02-17 21:39:03 UTC
  • mfrom: (635.1.60 nova)
  • Revision ID: sandy.walsh@rackspace.com-20110217213903-swehe88wea8inxow
changed from 003-004 migration

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
47
47
  from nova.auth import users
48
48
  from nova.endpoint import api
49
49
  from nova.endpoint import cloud
 
50
 
 
51
Docstrings
 
52
----------
 
53
  """Summary of the function, class or method, less than 80 characters.
 
54
 
 
55
  New paragraph after newline that explains in more detail any general
 
56
  information about the function, class or method. After this, if defining
 
57
  parameters and return types use the Sphinx format. After that an extra
 
58
  newline then close the quotations.
 
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
 
 
64
  :param foo: the foo parameter
 
65
  :param bar: the bar parameter
 
66
  :returns: description of the return value
 
67
 
 
68
  """