openstack/keystoneauth
Code Issues Proposed changes

Fixing D301 docstring.

Browse Source 
Currently tox ignores D301 (D301: Use r”“” if anybackslashes in a
docstring). This change removes D301 ignore.
All pep8 violatios are fixed.

Change-Id: Icfe41f21ce26e687c322daca4a927de2ebdb9848
This commit is contained in:
Navid Pustchi 2016-04-19 06:35:59 +00:00
parent 2e0c0030a9
commit 2caee11017
5 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
keystoneauth1/_utils.py
View File

@ -44,7 +44,7 @@ def parse_isotime(timestr):
def from_utcnow(**timedelta_kwargs): def from_utcnow(**timedelta_kwargs):
"""Calculate the time in the future from utcnow. r"""Calculate the time in the future from utcnow.
:param \*\*timedelta_kwargs: :param \*\*timedelta_kwargs:
Passed directly to :class:`datetime.timedelta` to add to the current Passed directly to :class:`datetime.timedelta` to add to the current
@ -60,7 +60,7 @@ def from_utcnow(**timedelta_kwargs):
def before_utcnow(**timedelta_kwargs): def before_utcnow(**timedelta_kwargs):
"""Calculate the time in the past from utcnow. r"""Calculate the time in the past from utcnow.
:param \*\*timedelta_kwargs: :param \*\*timedelta_kwargs:
Passed directly to :class:`datetime.timedelta` to subtract from the Passed directly to :class:`datetime.timedelta` to subtract from the

2
keystoneauth1/extras/_saml2/v3/saml2.py
View File

@ -18,7 +18,7 @@ from keystoneauth1.extras._saml2.v3 import base
class Password(base.BaseSAMLPlugin): class Password(base.BaseSAMLPlugin):
"""Implement authentication plugin for SAML2 protocol. r"""Implement authentication plugin for SAML2 protocol.
ECP stands for `Enhanced Client or Proxy` and is a SAML2 extension ECP stands for `Enhanced Client or Proxy` and is a SAML2 extension
for federated authentication where a transportation layer consists of for federated authentication where a transportation layer consists of

2
keystoneauth1/identity/v3/oidc.py
View File

@ -101,7 +101,7 @@ class _OidcBase(federation.FederationBaseAuth):
return op_response return op_response
def _get_keystone_token(self, session, headers, federated_token_url): def _get_keystone_token(self, session, headers, federated_token_url):
"""Exchange an acess token for a keystone token. r"""Exchange an acess token for a keystone token.
By Sending the access token in an `Authorization: Bearer` header, to By Sending the access token in an `Authorization: Bearer` header, to
an OpenID Connect protected endpoint (Federated Token URL). The an OpenID Connect protected endpoint (Federated Token URL). The

2
keystoneauth1/tests/unit/utils.py
View File

@ -72,7 +72,7 @@ class TestCase(testtools.TestCase):
self.assertEqual(body, last_request_body) self.assertEqual(body, last_request_body)
def assertQueryStringIs(self, qs=''): def assertQueryStringIs(self, qs=''):
"""Verify the QueryString matches what is expected. r"""Verify the QueryString matches what is expected.
The qs parameter should be of the format \'foo=bar&abc=xyz\' The qs parameter should be of the format \'foo=bar&abc=xyz\'
""" """

3
tox.ini
View File

@ -42,8 +42,7 @@ commands = oslo_debug_helper -t keystoneauth1/tests {posargs}
# D205: Blank line required between one-line summary and description. # D205: Blank line required between one-line summary and description.
# D208: Docstring is over-indented # D208: Docstring is over-indented
# D211: No blank lines allowed before class docstring # D211: No blank lines allowed before class docstring
# D301: Use r”“” if any backslashes in a docstring ignore = H405,D100,D101,D102,D103,D104,D105,D200,D203,D204,D205,D208,D211
ignore = H405,D100,D101,D102,D103,D104,D105,D200,D203,D204,D205,D208,D211,D301
show-source = True show-source = True
exclude = .venv,.tox,dist,doc,*egg,build,*openstack/common* exclude = .venv,.tox,dist,doc,*egg,build,*openstack/common*