summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGage Hugo <gagehugo@gmail.com>2017-02-09 10:22:28 -0600
committerGage Hugo <gagehugo@gmail.com>2017-02-09 10:22:28 -0600
commit67b1cd3705c0e45f0304f8a9d008b03f554ec7d2 (patch)
treecd22ae38f953816894777913c5d6dce0d89ac47d
parent689729fa354921152cb1bd7220056a89b627e66e (diff)
downloadpython-keystoneclient-67b1cd3705c0e45f0304f8a9d008b03f554ec7d2.tar.gz
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
-rw-r--r--keystoneclient/auth/base.py2
-rw-r--r--keystoneclient/auth/cli.py2
-rw-r--r--keystoneclient/auth/identity/v3/base.py6
-rw-r--r--keystoneclient/discover.py2
-rw-r--r--keystoneclient/v3/contrib/federation/identity_providers.py2
5 files changed, 7 insertions, 7 deletions
diff --git a/keystoneclient/auth/base.py b/keystoneclient/auth/base.py
index df7521c..0036b8c 100644
--- a/keystoneclient/auth/base.py
+++ b/keystoneclient/auth/base.py
@@ -252,7 +252,7 @@ class BaseAuthPlugin(object):
:returns: A list of Param objects describing available plugin
parameters.
- :rtype: list
+ :rtype: List
"""
return []
diff --git a/keystoneclient/auth/cli.py b/keystoneclient/auth/cli.py
index d8cc820..1b8e054 100644
--- a/keystoneclient/auth/cli.py
+++ b/keystoneclient/auth/cli.py
@@ -32,7 +32,7 @@ def register_argparse_arguments(parser, argv, default=None):
the options required for that specific plugin if available.
: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
if one isn't specified by the CLI. default: None.
diff --git a/keystoneclient/auth/identity/v3/base.py b/keystoneclient/auth/identity/v3/base.py
index d82c289..3576045 100644
--- a/keystoneclient/auth/identity/v3/base.py
+++ b/keystoneclient/auth/identity/v3/base.py
@@ -33,7 +33,7 @@ class BaseAuth(base.BaseIdentityPlugin):
"""Identity V3 Authentication Plugin.
: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 domain_id: Domain ID for domain scoping.
:param string domain_name: Domain name for domain scoping.
@@ -111,7 +111,7 @@ class Auth(BaseAuth):
"""Identity V3 Authentication Plugin.
: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 domain_id: Domain ID for domain scoping.
:param string domain_name: Domain name for domain scoping.
@@ -235,7 +235,7 @@ class AuthMethod(object):
:param session: The communication 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
request if a plugin needs to add to them.
:return: The identifier of this plugin and a dict of authentication
diff --git a/keystoneclient/discover.py b/keystoneclient/discover.py
index 85b0875..6b9a167 100644
--- a/keystoneclient/discover.py
+++ b/keystoneclient/discover.py
@@ -231,7 +231,7 @@ class Discover(_discover.Discover):
:returns: The endpoints returned from the server that match the
criteria.
- :rtype: list
+ :rtype: List
Example::
diff --git a/keystoneclient/v3/contrib/federation/identity_providers.py b/keystoneclient/v3/contrib/federation/identity_providers.py
index 85c4a73..4675ca3 100644
--- a/keystoneclient/v3/contrib/federation/identity_providers.py
+++ b/keystoneclient/v3/contrib/federation/identity_providers.py
@@ -79,7 +79,7 @@ class IdentityProviderManager(base.CrudManager):
GET /OS-FEDERATION/identity_providers
:returns: a list of IdentityProvider resource objects.
- :rtype: list
+ :rtype: List
"""
return super(IdentityProviderManager, self).list(**kwargs)