openstack/keystone
Code Issues Proposed changes

Correct docstrings

Browse Source 
There were several warnings logged when docs were built due to
invalid rst and other issues.

Change-Id: I61289d05377b8e70afbcf8786d4159354aa67ed8
This commit is contained in:
Brant Knudson
2016-02-01 15:22:39 -06:00
committed by Steve Martinelli
parent 836dbfca42
commit c420c81fcf
8 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/developing.rst
View File

@@ -183,7 +183,7 @@ guidelines for schema and data migrations should be followed:
are filled with null values before removing them. are filled with null values before removing them.
A good example of an online schema migration is documented in a `cinder spec`_. A good example of an online schema migration is documented in a `cinder spec`_.
See more examples in :doc:`devref/online_schema_migration_examples`. See more examples in :doc:`online_schema_migration_examples`.
.. _`online schema migration`: https://specs.openstack.org/openstack/keystone-specs/specs/mitaka/online-schema-migration.html .. _`online schema migration`: https://specs.openstack.org/openstack/keystone-specs/specs/mitaka/online-schema-migration.html
.. _`MySQL docs`: https://dev.mysql.com/doc/refman/5.7/en/innodb-create-index-overview.html .. _`MySQL docs`: https://dev.mysql.com/doc/refman/5.7/en/innodb-create-index-overview.html

2
doc/source/index.rst
View File

@@ -84,8 +84,8 @@ Developers Documentation
apache-httpd apache-httpd
external-auth external-auth
event_notifications event_notifications
extension_development
services services
online_schema_migration_examples
Code Documentation Code Documentation
================== ==================

2
doc/source/installing.rst
View File

@@ -56,7 +56,7 @@ Install the Keystone web service:
This step is guaranteed to fail if you do not have the proper binary This step is guaranteed to fail if you do not have the proper binary
dependencies already installed on your development system. Maintaining a dependencies already installed on your development system. Maintaining a
list of platform-specific dependencies is outside the scope of this list of platform-specific dependencies is outside the scope of this
documentation, but is within scope of `DevStack <http://devstack.org/>`_. documentation, but is within scope of DEVSTACK_.
You should have all the pieces you need to run Keystone installed on your You should have all the pieces you need to run Keystone installed on your
system. The following commands should be available on the command-line path: system. The following commands should be available on the command-line path:

0
doc/source/devref/online_schema_migration_examples.rst → doc/source/online_schema_migration_examples.rst
View File

2
keystone/tests/unit/core.py
View File

@@ -849,7 +849,7 @@ class SQLDriverOverrides(object):
:param driver_path: The path to the drivers, e.g. 'keystone.assignment' :param driver_path: The path to the drivers, e.g. 'keystone.assignment'
:param versionless_backend: The name of the versionless drivers, e.g. :param versionless_backend: The name of the versionless drivers, e.g.
'backends' 'backends'
:param version_suffix: The suffix for the version , e.g. 'V8_' :param version_suffix: The suffix for the version , e.g. ``V8_``
This method assumes that versioned drivers are named: This method assumes that versioned drivers are named:
<version_suffix><name of versionless driver>, e.g. 'V8_backends'. <version_suffix><name of versionless driver>, e.g. 'V8_backends'.