Fix some docstring syntax error

TrivialFix
Ref: http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists

Change-Id: Ibb83aa478a4e9b6d488105728a8dc15a557339f4
This commit is contained in:
ckji 2017-03-23 10:37:23 +08:00
parent d185a03707
commit 8779b070ae
7 changed files with 11 additions and 11 deletions

View File

@ -452,7 +452,7 @@ class ExtensionManager(object):
def extend_resources(self, version, attr_map):
"""Extend resources with additional resources or attributes.
:param: attr_map, the existing mapping from resource name to
:param attr_map: the existing mapping from resource name to
attrs definition.
After this function, we will extend the attr_map if an extension

View File

@ -493,7 +493,7 @@ def convert_to_int(data):
def convert_kvp_str_to_list(data):
"""Convert a value of the form 'key=value' to ['key', 'value'].
:raises: n_exc.InvalidInput if any of the strings are malformed
:raises n_exc.InvalidInput: if any of the strings are malformed
(e.g. do not contain a key).
"""
kvp = [x.strip() for x in data.split('=', 1)]
@ -506,7 +506,7 @@ def convert_kvp_str_to_list(data):
def convert_kvp_list_to_dict(kvp_list):
"""Convert a list of 'key=value' strings to a dict.
:raises: n_exc.InvalidInput if any of the strings are malformed
:raises n_exc.InvalidInput: if any of the strings are malformed
(e.g. do not contain a key) or if any
of the keys appear more than once.
"""

View File

@ -117,8 +117,8 @@ def load_paste_app(app_name):
"""Builds and returns a WSGI app from a paste config file.
:param app_name: Name of the application to load
:raises ConfigFilesNotFoundError when config file cannot be located
:raises RuntimeError when application cannot be loaded from config file
:raises ConfigFilesNotFoundError: when config file cannot be located
:raises RuntimeError: when application cannot be loaded from config file
"""
config_path = cfg.CONF.find_file(cfg.CONF.api_paste_config)

View File

@ -178,8 +178,8 @@ def load_class_by_alias_or_classname(namespace, name):
Load class using the stevedore driver manager
:param namespace: namespace where the alias is defined
:param name: alias or class name of the class to be loaded
:returns class if calls can be loaded
:raises ImportError if class cannot be loaded
:returns: class if calls can be loaded
:raises ImportError: if class cannot be loaded
"""
if not name:

View File

@ -108,8 +108,8 @@ class TackerManager(object):
Load class using stevedore alias or the class name
:param namespace: namespace where alias is defined
:param plugin_provider: plugin alias or class name
:returns plugin that is loaded
:raises ImportError if fails to load plugin
:returns: plugin that is loaded
:raises ImportError: if fails to load plugin
"""
try:

View File

@ -517,7 +517,7 @@ class NfvoPlugin(nfvo_db.NfvoPluginDb, vnffg_db.VnffgPluginDbMixin,
def create_ns(self, context, ns):
"""Create NS and corresponding VNFs.
:param ns ns dict which contains nsd_id and attributes
:param ns: ns dict which contains nsd_id and attributes
This method has 3 steps:
step-1: substitute all get_input params to its corresponding values
step-2: Build params dict for substitution mappings case through which

View File

@ -511,7 +511,7 @@ class RequestDeserializer(object):
"""Extract necessary pieces of the request.
:param request: Request object
:returns tuple of expected controller action name, dictionary of
:returns: tuple of expected controller action name, dictionary of
keyword arguments to pass to the controller, the expected
content type of the response