Fix 12 warnings when building keystoneclient docs
While building keystoneclient docs, there are currently 12 warnings emitted that specify either: WARNING: more than one target found for cross-reference u'list' WARNING: more than one target found for cross-reference u'Auth' This change specifies the correct object for the docstring with "List" since there are many instances of "list" within keystoneclient and specifies the proper "Auth" object. With these changes, the warnings no longer appear. Change-Id: I4515429df38760700552d48fc570c03abf116f83
This commit is contained in:
parent
689729fa35
commit
67b1cd3705
|
@ -252,7 +252,7 @@ class BaseAuthPlugin(object):
|
||||||
|
|
||||||
:returns: A list of Param objects describing available plugin
|
:returns: A list of Param objects describing available plugin
|
||||||
parameters.
|
parameters.
|
||||||
:rtype: list
|
:rtype: List
|
||||||
"""
|
"""
|
||||||
return []
|
return []
|
||||||
|
|
||||||
|
|
|
@ -32,7 +32,7 @@ def register_argparse_arguments(parser, argv, default=None):
|
||||||
the options required for that specific plugin if available.
|
the options required for that specific plugin if available.
|
||||||
|
|
||||||
:param argparse.ArgumentParser: the parser to attach argparse options to.
|
:param argparse.ArgumentParser: the parser to attach argparse options to.
|
||||||
:param list argv: the arguments provided to the application.
|
:param List argv: the arguments provided to the application.
|
||||||
:param str/class default: a default plugin name or a plugin object to use
|
:param str/class default: a default plugin name or a plugin object to use
|
||||||
if one isn't specified by the CLI. default: None.
|
if one isn't specified by the CLI. default: None.
|
||||||
|
|
||||||
|
|
|
@ -33,7 +33,7 @@ class BaseAuth(base.BaseIdentityPlugin):
|
||||||
"""Identity V3 Authentication Plugin.
|
"""Identity V3 Authentication Plugin.
|
||||||
|
|
||||||
:param string auth_url: Identity service endpoint for authentication.
|
:param string auth_url: Identity service endpoint for authentication.
|
||||||
:param list auth_methods: A collection of methods to authenticate with.
|
:param List auth_methods: A collection of methods to authenticate with.
|
||||||
:param string trust_id: Trust ID for trust scoping.
|
:param string trust_id: Trust ID for trust scoping.
|
||||||
:param string domain_id: Domain ID for domain scoping.
|
:param string domain_id: Domain ID for domain scoping.
|
||||||
:param string domain_name: Domain name for domain scoping.
|
:param string domain_name: Domain name for domain scoping.
|
||||||
|
@ -111,7 +111,7 @@ class Auth(BaseAuth):
|
||||||
"""Identity V3 Authentication Plugin.
|
"""Identity V3 Authentication Plugin.
|
||||||
|
|
||||||
:param string auth_url: Identity service endpoint for authentication.
|
:param string auth_url: Identity service endpoint for authentication.
|
||||||
:param list auth_methods: A collection of methods to authenticate with.
|
:param List auth_methods: A collection of methods to authenticate with.
|
||||||
:param string trust_id: Trust ID for trust scoping.
|
:param string trust_id: Trust ID for trust scoping.
|
||||||
:param string domain_id: Domain ID for domain scoping.
|
:param string domain_id: Domain ID for domain scoping.
|
||||||
:param string domain_name: Domain name for domain scoping.
|
:param string domain_name: Domain name for domain scoping.
|
||||||
|
@ -235,7 +235,7 @@ class AuthMethod(object):
|
||||||
|
|
||||||
:param session: The communication session.
|
:param session: The communication session.
|
||||||
:type session: keystoneclient.session.Session
|
:type session: keystoneclient.session.Session
|
||||||
:param Auth auth: The auth plugin calling the method.
|
:param base.Auth auth: The auth plugin calling the method.
|
||||||
:param dict headers: The headers that will be sent with the auth
|
:param dict headers: The headers that will be sent with the auth
|
||||||
request if a plugin needs to add to them.
|
request if a plugin needs to add to them.
|
||||||
:return: The identifier of this plugin and a dict of authentication
|
:return: The identifier of this plugin and a dict of authentication
|
||||||
|
|
|
@ -231,7 +231,7 @@ class Discover(_discover.Discover):
|
||||||
|
|
||||||
:returns: The endpoints returned from the server that match the
|
:returns: The endpoints returned from the server that match the
|
||||||
criteria.
|
criteria.
|
||||||
:rtype: list
|
:rtype: List
|
||||||
|
|
||||||
Example::
|
Example::
|
||||||
|
|
||||||
|
|
|
@ -79,7 +79,7 @@ class IdentityProviderManager(base.CrudManager):
|
||||||
GET /OS-FEDERATION/identity_providers
|
GET /OS-FEDERATION/identity_providers
|
||||||
|
|
||||||
:returns: a list of IdentityProvider resource objects.
|
:returns: a list of IdentityProvider resource objects.
|
||||||
:rtype: list
|
:rtype: List
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return super(IdentityProviderManager, self).list(**kwargs)
|
return super(IdentityProviderManager, self).list(**kwargs)
|
||||||
|
|
Loading…
Reference in New Issue