openstack/keystonemiddleware
Code Issues Proposed changes

clean up a few doc building warnings

Browse Source 
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
This commit is contained in:
Steve Martinelli 2016-12-14 22:48:09 -05:00
parent 29a879c0ed
commit 1d930a281f
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/index.rst
View File

@ -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
==================

10
keystonemiddleware/auth_token/__init__.py
View File

@ -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,