Docs are generated incorrectly

When docs are generated with pbr command 'warnerrors = True'
there are many doc problems that are shown. This patch fixes
these problems.

Change-Id: Idb804ab924782b6d7d379494987bdba2acbce568
Closes-Bug: #1557235
This commit is contained in:
Tom Cocozzello
2016-03-16 16:34:46 -05:00
parent d59e341a4c
commit c6904d0332
5 changed files with 25 additions and 9 deletions
+6 -5
View File
@@ -102,7 +102,8 @@ class NamespaceController(object):
in a subsequent limited request.
:param sort_key: The field to sort on (for example, 'created_at')
:param sort_dir: The direction to sort ('asc' or 'desc')
:returns generator over list of Namespaces
:returns: generator over list of Namespaces
"""
ori_validate_fun = self.model.validate
@@ -209,7 +210,7 @@ class ResourceTypeController(object):
def list(self):
"""Retrieve a listing of available resource types.
:returns generator over list of resource_types
:returns: generator over list of resource_types
"""
url = '/v2/metadefs/resource_types'
@@ -283,7 +284,7 @@ class PropertyController(object):
def list(self, namespace, **kwargs):
"""Retrieve a listing of metadata properties.
:returns generator over list of objects
:returns: generator over list of objects
"""
url = '/v2/metadefs/namespaces/{0}/properties'.format(namespace)
@@ -368,7 +369,7 @@ class ObjectController(object):
def list(self, namespace, **kwargs):
"""Retrieve a listing of metadata objects.
:returns generator over list of objects
:returns: generator over list of objects
"""
url = '/v2/metadefs/namespaces/{0}/objects'.format(namespace,)
resp, body = self.http_client.get(url)
@@ -472,7 +473,7 @@ class TagController(object):
def list(self, namespace, **kwargs):
"""Retrieve a listing of metadata tags.
:returns generator over list of tags.
:returns: generator over list of tags.
"""
url = '/v2/metadefs/namespaces/{0}/tags'.format(namespace)
resp, body = self.http_client.get(url)