From 1d930a281f5715c31dc8b66e78ffd8c6b6a4159b Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Wed, 14 Dec 2016 22:48:09 -0500 Subject: [PATCH] clean up a few doc building warnings Fixed two warnings: - keystonemiddleware/auth_token/__init__.py:docstring of keystonemiddleware.auth_token.BaseAuthProtocol.kwargs_to_fetch_token WARNING: Inline strong start-string without end-string. - keystonemiddleware/doc/source/api/modules.rst WARNING: document isn't included in any toctree Change-Id: Iaec9adb228fe9131365ab1c15d4c85567921ccdd --- doc/source/index.rst | 7 +++++++ keystonemiddleware/auth_token/__init__.py | 10 ++++------ 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index b784d026..97ca5f73 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -47,6 +47,13 @@ using `Gerrit`_. Run tests with ``tox -e py27`` if running with python 2.7. See the ``tox.ini`` file for other test environment options. +Code Documentation +================== +.. toctree:: + :maxdepth: 1 + + api/modules + Indices and tables ================== diff --git a/keystonemiddleware/auth_token/__init__.py b/keystonemiddleware/auth_token/__init__.py index 7c522e1d..33e57916 100644 --- a/keystonemiddleware/auth_token/__init__.py +++ b/keystonemiddleware/auth_token/__init__.py @@ -307,13 +307,11 @@ class BaseAuthProtocol(object): perform. """ - # NOTE(jamielennox): Default to True and remove in Pike. + # NOTE(jamielennox): Default to True and remove in Pike. This is a + # compatibility flag to allow passing **kwargs to fetch_token(). This + # is basically to allow compatibility with keystone's override. We will + # assume all subclasses are ok with this being True in the Pike release. kwargs_to_fetch_token = False - """A compatibility flag to allow passing **kwargs to fetch_token(). - - This is basically to allow compatibility with keystone's override. We will - assume all subclasses are ok with this being True in the Pike release. - """ def __init__(self, app,