From 70170656fd4d3c8020391354b13dca63e9e024d1 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Mon, 20 Mar 2017 16:19:27 +0000
Subject: doc: Correct Sphinx warnings

- Fix option-describe typos
- Correct option and envvar markup, for commands that are using the
  reference form instead of the definition form or are marking up
  option arguments as options
- Avoid duplicate commands
- Fix some invalid docstrings
- Fix some invalid indentation
- Disable the murano plugin, which has invalid docs
- Correct issues with- and track the network-topology spec
- Include API modules in docs

Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
---
 openstackclient/compute/client.py               | 1 +
 openstackclient/tests/unit/identity/v3/fakes.py | 4 ++--
 openstackclient/tests/unit/image/v2/fakes.py    | 6 +++---
 3 files changed, 6 insertions(+), 5 deletions(-)

(limited to 'openstackclient')

diff --git a/openstackclient/compute/client.py b/openstackclient/compute/client.py
index c5b364b2..b4b463b4 100644
--- a/openstackclient/compute/client.py
+++ b/openstackclient/compute/client.py
@@ -96,6 +96,7 @@ def check_api_version(check_version):
     """Validate version supplied by user
 
     Returns:
+
     * True if version is OK
     * False if the version has not been checked and the previous plugin
       check should be performed
diff --git a/openstackclient/tests/unit/identity/v3/fakes.py b/openstackclient/tests/unit/identity/v3/fakes.py
index 139d90d5..291f977d 100644
--- a/openstackclient/tests/unit/identity/v3/fakes.py
+++ b/openstackclient/tests/unit/identity/v3/fakes.py
@@ -729,7 +729,7 @@ class FakeCredential(object):
             A list of FakeResource objects faking credentials
         :param Integer count:
             The number of credentials to be faked
-        :return
+        :return:
             An iterable Mock object with side_effect set to a list of faked
             credentials
         """
@@ -867,7 +867,7 @@ class FakeGroup(object):
             A list of FakeResource objects faking groups
         :param Integer count:
             The number of groups to be faked
-        :return
+        :return:
             An iterable Mock object with side_effect set to a list of faked
             groups
         """
diff --git a/openstackclient/tests/unit/image/v2/fakes.py b/openstackclient/tests/unit/image/v2/fakes.py
index 8e2f587d..7f3f02df 100644
--- a/openstackclient/tests/unit/image/v2/fakes.py
+++ b/openstackclient/tests/unit/image/v2/fakes.py
@@ -238,7 +238,7 @@ class FakeImage(object):
             A list of FakeResource objects faking images
         :param Integer count:
             The number of images to be faked
-        :return
+        :return:
             An iterable Mock object with side_effect set to a list of faked
             images
         """
@@ -253,7 +253,7 @@ class FakeImage(object):
 
         :param image:
             A FakeResource objects faking image
-        :return
+        :return:
             A tuple which may include the following keys:
             ('id', 'name', 'owner', 'protected', 'visibility', 'tags')
         """
@@ -267,7 +267,7 @@ class FakeImage(object):
 
         :param image:
             A FakeResource objects faking image
-        :return
+        :return:
             A tuple which may include the following values:
             ('image-123', 'image-foo', 'admin', False, 'public', 'bar, baz')
         """
-- 
cgit v1.2.1