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:
@@ -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)
|
||||
|
||||
@@ -71,7 +71,7 @@ class SchemaProperty(object):
|
||||
def translate_schema_properties(schema_properties):
|
||||
"""Parse the properties dictionary of a schema document.
|
||||
|
||||
:returns list of SchemaProperty objects
|
||||
:returns: list of SchemaProperty objects
|
||||
"""
|
||||
properties = []
|
||||
for (name, prop) in schema_properties.items():
|
||||
|
||||
@@ -41,7 +41,8 @@ class Controller(object):
|
||||
"""Retrieve a listing of Task objects.
|
||||
|
||||
:param page_size: Number of tasks to request in each paginated request
|
||||
:returns generator over list of Tasks
|
||||
:returns: generator over list of Tasks
|
||||
|
||||
"""
|
||||
def paginate(url):
|
||||
resp, body = self.http_client.get(url)
|
||||
|
||||
Reference in New Issue
Block a user