Merge "Fix some docstring syntax error"
This commit is contained in:
commit
da28bd5f95
@ -452,7 +452,7 @@ class ExtensionManager(object):
|
|||||||
def extend_resources(self, version, attr_map):
|
def extend_resources(self, version, attr_map):
|
||||||
"""Extend resources with additional resources or attributes.
|
"""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.
|
attrs definition.
|
||||||
|
|
||||||
After this function, we will extend the attr_map if an extension
|
After this function, we will extend the attr_map if an extension
|
||||||
|
@ -493,7 +493,7 @@ def convert_to_int(data):
|
|||||||
def convert_kvp_str_to_list(data):
|
def convert_kvp_str_to_list(data):
|
||||||
"""Convert a value of the form 'key=value' to ['key', 'value'].
|
"""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).
|
(e.g. do not contain a key).
|
||||||
"""
|
"""
|
||||||
kvp = [x.strip() for x in data.split('=', 1)]
|
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):
|
def convert_kvp_list_to_dict(kvp_list):
|
||||||
"""Convert a list of 'key=value' strings to a dict.
|
"""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
|
(e.g. do not contain a key) or if any
|
||||||
of the keys appear more than once.
|
of the keys appear more than once.
|
||||||
"""
|
"""
|
||||||
|
@ -117,8 +117,8 @@ def load_paste_app(app_name):
|
|||||||
"""Builds and returns a WSGI app from a paste config file.
|
"""Builds and returns a WSGI app from a paste config file.
|
||||||
|
|
||||||
:param app_name: Name of the application to load
|
:param app_name: Name of the application to load
|
||||||
:raises ConfigFilesNotFoundError when config file cannot be located
|
:raises ConfigFilesNotFoundError: when config file cannot be located
|
||||||
:raises RuntimeError when application cannot be loaded from config file
|
:raises RuntimeError: when application cannot be loaded from config file
|
||||||
"""
|
"""
|
||||||
|
|
||||||
config_path = cfg.CONF.find_file(cfg.CONF.api_paste_config)
|
config_path = cfg.CONF.find_file(cfg.CONF.api_paste_config)
|
||||||
|
@ -178,8 +178,8 @@ def load_class_by_alias_or_classname(namespace, name):
|
|||||||
Load class using the stevedore driver manager
|
Load class using the stevedore driver manager
|
||||||
:param namespace: namespace where the alias is defined
|
:param namespace: namespace where the alias is defined
|
||||||
:param name: alias or class name of the class to be loaded
|
:param name: alias or class name of the class to be loaded
|
||||||
:returns class if calls can be loaded
|
:returns: class if calls can be loaded
|
||||||
:raises ImportError if class cannot be loaded
|
:raises ImportError: if class cannot be loaded
|
||||||
"""
|
"""
|
||||||
|
|
||||||
if not name:
|
if not name:
|
||||||
|
@ -108,8 +108,8 @@ class TackerManager(object):
|
|||||||
Load class using stevedore alias or the class name
|
Load class using stevedore alias or the class name
|
||||||
:param namespace: namespace where alias is defined
|
:param namespace: namespace where alias is defined
|
||||||
:param plugin_provider: plugin alias or class name
|
:param plugin_provider: plugin alias or class name
|
||||||
:returns plugin that is loaded
|
:returns: plugin that is loaded
|
||||||
:raises ImportError if fails to load plugin
|
:raises ImportError: if fails to load plugin
|
||||||
"""
|
"""
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
@ -517,7 +517,7 @@ class NfvoPlugin(nfvo_db.NfvoPluginDb, vnffg_db.VnffgPluginDbMixin,
|
|||||||
def create_ns(self, context, ns):
|
def create_ns(self, context, ns):
|
||||||
"""Create NS and corresponding VNFs.
|
"""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:
|
This method has 3 steps:
|
||||||
step-1: substitute all get_input params to its corresponding values
|
step-1: substitute all get_input params to its corresponding values
|
||||||
step-2: Build params dict for substitution mappings case through which
|
step-2: Build params dict for substitution mappings case through which
|
||||||
|
@ -511,7 +511,7 @@ class RequestDeserializer(object):
|
|||||||
"""Extract necessary pieces of the request.
|
"""Extract necessary pieces of the request.
|
||||||
|
|
||||||
:param request: Request object
|
: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
|
keyword arguments to pass to the controller, the expected
|
||||||
content type of the response
|
content type of the response
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user