summaryrefslogtreecommitdiff
path: root/ironic/api/controllers/v1/collection.py
diff options
context:
space:
mode:
authorRuby Loo <rloo@yahoo-inc.com>2014-10-27 21:37:22 +0000
committerRuby Loo <rloo@yahoo-inc.com>2014-10-27 21:47:18 +0000
commitfb6cf77d97d05c7b0f50204f12c1905cda7552f4 (patch)
tree384775ab5da0739e749d3a40278ea93770076296 /ironic/api/controllers/v1/collection.py
parent9cee24e257031c74afcbc9e37c0b705240e9b399 (diff)
downloadironic-fb6cf77d97d05c7b0f50204f12c1905cda7552f4.tar.gz
Use docstrings for attributes in api/controllers
We're using one double-quote for delimiting the strings that describe attributes. If the string spans more than one line, only the first line is used when sphinx generates the documentation. eg, for last_error, the generated documentation shows: Any error from the most recent (last) asynchronous transaction that instead of Any error from the most recent (last) asynchronous transaction that started but failed to finish. Using the docstring (three double-quotes) syntax addresses this. All the attributes in api/controllers were modified accordingly. This makes them consistent so that any additions/changes to these strings in the future will appear in the generated documentation as expected. (As opposed to only changing the ones that span more than one line.) [1] http://docs.openstack.org/developer/ironic/webapi/v1.html Change-Id: I84e4ba9c22827838ff31ba96a788cfc22609c8a5
Diffstat (limited to 'ironic/api/controllers/v1/collection.py')
-rw-r--r--ironic/api/controllers/v1/collection.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/ironic/api/controllers/v1/collection.py b/ironic/api/controllers/v1/collection.py
index 6ec298791..c60df9a3a 100644
--- a/ironic/api/controllers/v1/collection.py
+++ b/ironic/api/controllers/v1/collection.py
@@ -23,7 +23,7 @@ from ironic.api.controllers import link
class Collection(base.APIBase):
next = wtypes.text
- "A link to retrieve the next subset of the collection"
+ """A link to retrieve the next subset of the collection"""
@property
def collection(self):