From 14c955cf6d4b673a6612fb8f3463bb275cc9fcd7 Mon Sep 17 00:00:00 2001 From: Brant Knudson Date: Mon, 21 Sep 2015 15:34:45 -0500 Subject: [PATCH] Fix warnings in docstrings When generating the docs some warnings were generated. Also, configure doc build so that if there are warnings, the build will fail. Change-Id: I7e10499294cf1f06f766cbff392e9de32ea48e5a --- oslo_db/options.py | 6 +++--- oslo_db/sqlalchemy/enginefacade.py | 1 - oslo_db/sqlalchemy/test_migrations.py | 2 +- setup.cfg | 4 +--- 4 files changed, 5 insertions(+), 8 deletions(-) diff --git a/oslo_db/options.py b/oslo_db/options.py index 42de9487..5d8f74ce 100644 --- a/oslo_db/options.py +++ b/oslo_db/options.py @@ -152,9 +152,9 @@ def set_defaults(conf, connection=None, sqlite_db=None, :keyword connection: SQL connection string. Valid SQLite URL forms are: - * sqlite:///:memory: (or, sqlite://) - * sqlite:///relative/path/to/file.db - * sqlite:////absolute/path/to/file.db + * sqlite:///:memory: (or, sqlite://) + * sqlite:///relative/path/to/file.db + * sqlite:////absolute/path/to/file.db :type connection: str :keyword sqlite_db: path to SQLite database file. diff --git a/oslo_db/sqlalchemy/enginefacade.py b/oslo_db/sqlalchemy/enginefacade.py index 8b241cf0..9243351a 100644 --- a/oslo_db/sqlalchemy/enginefacade.py +++ b/oslo_db/sqlalchemy/enginefacade.py @@ -842,7 +842,6 @@ class LegacyEngineFacade(object): """A helper class for removing of global engine instances from oslo.db. .. deprecated:: - EngineFacade is deprecated. Please use oslo.db.sqlalchemy.enginefacade for new development. diff --git a/oslo_db/sqlalchemy/test_migrations.py b/oslo_db/sqlalchemy/test_migrations.py index 627e5633..9e0f6437 100644 --- a/oslo_db/sqlalchemy/test_migrations.py +++ b/oslo_db/sqlalchemy/test_migrations.py @@ -166,7 +166,7 @@ class WalkVersionsMixin(object): If we have ordered migrations 123abc, 456def, 789ghi and we run upgrading with the `snake_walk` argument set to `True`, the - migrations will be applied in the following order: + migrations will be applied in the following order:: `123abc => 456def => 123abc => 456def => 789ghi => 456def => 789ghi` diff --git a/setup.cfg b/setup.cfg index 649550b1..145ee6a8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -60,9 +60,7 @@ fixtures = testscenarios>=0.4 [pbr] -# NOTE(viktors): uncomment ``warnerrors`` line, when setup.cfg we then -# want to treat sphinx warnings as errors -# warnerrors = True +warnerrors = True autodoc_index_modules = True autodoc_exclude_modules = oslo_db.tests.* \ No newline at end of file