diff options
| author | Brant Knudson <bknudson@us.ibm.com> | 2014-10-12 19:41:38 -0500 |
|---|---|---|
| committer | Brant Knudson <bknudson@us.ibm.com> | 2014-10-18 17:59:08 -0500 |
| commit | 14a6d80116c5d9410d1c52bee833beb10837df28 (patch) | |
| tree | 00c93bc0b0566ec25b7577062c3198e9209eb9fa /keystoneclient/auth | |
| parent | 8b267842a701970d4e1aae2f115afe4d73bc5ee6 (diff) | |
| download | python-keystoneclient-14a6d80116c5d9410d1c52bee833beb10837df28.tar.gz | |
Cleanup docs - raises class
The argument to the :raises: directive is the class name. If the
class name is a valid reference it's rendered as a link to the
class. This change cleans up the :raises: directives to use the
reference correctly and use a valid class reference.
Change-Id: I84188b60de0ab4c6b5b2fb5a203c43bfde094707
Diffstat (limited to 'keystoneclient/auth')
| -rw-r--r-- | keystoneclient/auth/base.py | 3 | ||||
| -rw-r--r-- | keystoneclient/auth/cli.py | 6 | ||||
| -rw-r--r-- | keystoneclient/auth/conf.py | 3 | ||||
| -rw-r--r-- | keystoneclient/auth/identity/base.py | 22 |
4 files changed, 23 insertions, 11 deletions
diff --git a/keystoneclient/auth/base.py b/keystoneclient/auth/base.py index 66e6a18..5fc737c 100644 --- a/keystoneclient/auth/base.py +++ b/keystoneclient/auth/base.py @@ -33,7 +33,8 @@ def get_plugin_class(name): :returns: An auth plugin class. - :raises exceptions.NoMatchingPlugin: if a plugin cannot be created. + :raises keystoneclient.exceptions.NoMatchingPlugin: if a plugin cannot be + created. """ try: mgr = stevedore.DriverManager(namespace=PLUGIN_NAMESPACE, diff --git a/keystoneclient/auth/cli.py b/keystoneclient/auth/cli.py index f1f2de3..ce4f11f 100644 --- a/keystoneclient/auth/cli.py +++ b/keystoneclient/auth/cli.py @@ -31,7 +31,8 @@ def register_argparse_arguments(parser, argv, default=None): :returns: The plugin class that will be loaded or None if not provided. - :raises exceptions.NoMatchingPlugin: if a plugin cannot be created. + :raises keystoneclient.exceptions.NoMatchingPlugin: if a plugin cannot be + created. """ in_parser = argparse.ArgumentParser(add_help=False) env_plugin = os.environ.get('OS_AUTH_PLUGIN', default) @@ -68,7 +69,8 @@ def load_from_argparse_arguments(namespace, **kwargs): :returns: An auth plugin, or None if a name is not provided. - :raises exceptions.NoMatchingPlugin: if a plugin cannot be created. + :raises keystoneclient.exceptions.NoMatchingPlugin: if a plugin cannot be + created. """ if not namespace.os_auth_plugin: return None diff --git a/keystoneclient/auth/conf.py b/keystoneclient/auth/conf.py index 52b60ba..34a206d 100644 --- a/keystoneclient/auth/conf.py +++ b/keystoneclient/auth/conf.py @@ -90,7 +90,8 @@ def load_from_conf_options(conf, group, **kwargs): :returns plugin: An authentication Plugin or None if a name is not provided - :raises exceptions.NoMatchingPlugin: if a plugin cannot be created. + :raises keystoneclient.exceptions.NoMatchingPlugin: if a plugin cannot be + created. """ # NOTE(jamielennox): plugins are allowed to specify a 'section' which is # the group that auth options should be taken from. If not present they diff --git a/keystoneclient/auth/identity/base.py b/keystoneclient/auth/identity/base.py index a58de2a..a4938c2 100644 --- a/keystoneclient/auth/identity/base.py +++ b/keystoneclient/auth/identity/base.py @@ -73,8 +73,11 @@ class BaseIdentityPlugin(base.BaseAuthPlugin): when invoked. If you are looking to just retrieve the current auth data then you should use get_access. - :raises InvalidResponse: The response returned wasn't appropriate. - :raises HttpError: An error from an invalid HTTP response. + :raises keystoneclient.exceptions.InvalidResponse: The response + returned wasn't + appropriate. + :raises keystoneclient.exceptions.HttpError: An error from an invalid + HTTP response. :returns AccessInfo: Token access information. """ @@ -84,7 +87,8 @@ class BaseIdentityPlugin(base.BaseAuthPlugin): If a valid token is not present then a new one will be fetched. - :raises HttpError: An error from an invalid HTTP response. + :raises keystoneclient.exceptions.HttpError: An error from an invalid + HTTP response. :return string: A valid token. """ @@ -118,7 +122,8 @@ class BaseIdentityPlugin(base.BaseAuthPlugin): If a valid AccessInfo is present then it is returned otherwise a new one will be fetched. - :raises HttpError: An error from an invalid HTTP response. + :raises keystoneclient.exceptions.HttpError: An error from an invalid + HTTP response. :returns AccessInfo: Valid AccessInfo """ @@ -169,7 +174,8 @@ class BaseIdentityPlugin(base.BaseAuthPlugin): :param tuple version: The minimum version number required for this endpoint. (optional) - :raises HttpError: An error from an invalid HTTP response. + :raises keystoneclient.exceptions.HttpError: An error from an invalid + HTTP response. :return string or None: A valid endpoint URL or None if not available. """ @@ -240,8 +246,10 @@ class BaseIdentityPlugin(base.BaseAuthPlugin): (optional) Defaults to None (use a token if a plugin is installed). - :raises: DiscoveryFailure if for some reason the lookup fails. - :raises: HttpError An error from an invalid HTTP response. + :raises keystoneclient.exceptions.DiscoveryFailure: if for some reason + the lookup fails. + :raises keystoneclient.exceptions.HttpError: An error from an invalid + HTTP response. :returns: A discovery object with the results of looking up that URL. """ |
