diff --git a/keystoneauth1/_utils.py b/keystoneauth1/_utils.py index 7d0c48ff..cbc1b0e2 100644 --- a/keystoneauth1/_utils.py +++ b/keystoneauth1/_utils.py @@ -44,7 +44,7 @@ def parse_isotime(timestr): 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: 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): - """Calculate the time in the past from utcnow. + r"""Calculate the time in the past from utcnow. :param \*\*timedelta_kwargs: Passed directly to :class:`datetime.timedelta` to subtract from the diff --git a/keystoneauth1/extras/_saml2/v3/saml2.py b/keystoneauth1/extras/_saml2/v3/saml2.py index 8902a299..1b1736dc 100644 --- a/keystoneauth1/extras/_saml2/v3/saml2.py +++ b/keystoneauth1/extras/_saml2/v3/saml2.py @@ -18,7 +18,7 @@ from keystoneauth1.extras._saml2.v3 import base 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 for federated authentication where a transportation layer consists of diff --git a/keystoneauth1/identity/v3/oidc.py b/keystoneauth1/identity/v3/oidc.py index 4f497292..b8b0ecf2 100644 --- a/keystoneauth1/identity/v3/oidc.py +++ b/keystoneauth1/identity/v3/oidc.py @@ -101,7 +101,7 @@ class _OidcBase(federation.FederationBaseAuth): return op_response 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 an OpenID Connect protected endpoint (Federated Token URL). The diff --git a/keystoneauth1/tests/unit/utils.py b/keystoneauth1/tests/unit/utils.py index bbd94ce4..94895c91 100644 --- a/keystoneauth1/tests/unit/utils.py +++ b/keystoneauth1/tests/unit/utils.py @@ -72,7 +72,7 @@ class TestCase(testtools.TestCase): self.assertEqual(body, last_request_body) 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\' """ diff --git a/tox.ini b/tox.ini index 18ac6879..d8d7c80b 100644 --- a/tox.ini +++ b/tox.ini @@ -42,8 +42,7 @@ commands = oslo_debug_helper -t keystoneauth1/tests {posargs} # D205: Blank line required between one-line summary and description. # D208: Docstring is over-indented # 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,D301 +ignore = H405,D100,D101,D102,D103,D104,D105,D200,D203,D204,D205,D208,D211 show-source = True exclude = .venv,.tox,dist,doc,*egg,build,*openstack/common*