diff options
| author | Akihiro Motoki <amotoki@gmail.com> | 2017-07-06 21:02:55 +0000 |
|---|---|---|
| committer | Akihiro Motoki <amotoki@gmail.com> | 2017-07-11 14:11:03 +0000 |
| commit | 8d0a5a7fea70609e8b2a069dc3e50f32c75ddebf (patch) | |
| tree | 691b9faf8ea1b0e6037ec6f449935dc202d489e7 | |
| parent | ad8274cb8f4c5534b28aafdb06b40a2edc0447dc (diff) | |
| download | oslo-vmware-8d0a5a7fea70609e8b2a069dc3e50f32c75ddebf.tar.gz | |
Enable warning-is-error in doc build
- Fix docstring warnings
- pbr warnerrors is no longer needed.
Change-Id: I70532d99f34023b5fcce4373b6456cae2fbb642a
| -rw-r--r-- | oslo_vmware/hacking/checks.py | 4 | ||||
| -rw-r--r-- | oslo_vmware/objects/datastore.py | 3 | ||||
| -rw-r--r-- | setup.cfg | 2 |
3 files changed, 5 insertions, 4 deletions
diff --git a/oslo_vmware/hacking/checks.py b/oslo_vmware/hacking/checks.py index b6d3ad9..8591d71 100644 --- a/oslo_vmware/hacking/checks.py +++ b/oslo_vmware/hacking/checks.py @@ -41,8 +41,8 @@ def no_translate_logs(logical_line, filename): :param logical_line: The logical line to check. :param filename: The file name where the logical line exists. :returns: None if the logical line passes the check, otherwise a tuple - is yielded that contains the offending index in logical line and a - message describe the check validation failure. + is yielded that contains the offending index in logical line and a + message describe the check validation failure. """ if _log_translation_hint.match(logical_line): yield (0, "N537: Log messages should not be translated!") diff --git a/oslo_vmware/objects/datastore.py b/oslo_vmware/objects/datastore.py index 2966352..c435fd5 100644 --- a/oslo_vmware/objects/datastore.py +++ b/oslo_vmware/objects/datastore.py @@ -32,7 +32,7 @@ def get_datastore_by_ref(session, ds_ref): :param session: a vmware api session object :param ds_ref: managed object reference of a datastore - :rtype : a datastore object + :rtype: a datastore object """ lst_properties = ["summary.type", "summary.name", @@ -195,6 +195,7 @@ class DatastorePath(object): file path to a virtual disk. Note: + - Datastore path representations always uses forward slash as separator (hence the use of the posixpath module). - Datastore names are enclosed in square brackets. @@ -26,6 +26,7 @@ packages = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html @@ -46,7 +47,6 @@ output_file = oslo_vmware/locale/oslo_vmware.pot [pbr] autodoc_index_modules = 1 -warnerrors = True autodoc_exclude_modules = oslo_vmware._i18n oslo_vmware.tests.* |