some updates to HACKING to describe the docstrings

1 files changed, 15 insertions, 0 deletions

diff --git a/HACKING b/HACKING
index 3af2381bf..4e0dfc835 100644
--- a/HACKING
+++ b/HACKING
@@ -47,3 +47,18 @@ Human Alphabetical Order Examples
   from nova.auth import users
   from nova.endpoint import api
   from nova.endpoint import cloud
+
+Docstrings
+----------
+  """Summary of the function, class or method, less than 80 characters.
+
+  New paragraph after newline that explains in more detail any general
+  information about the function, class or method. After this, if defining
+  parameters and return types use the Sphinx format. After that an extra
+  newline then close the quotations.
+
+  :param foo: the foo parameter
+  :param bar: the bar parameter
+  :rtype: the return type
+
+  """