openstack/openstacksdk
Code Issues Proposed changes

Clean up some errant doc warnings/errors

Browse Source 
This change cleans up a couple of minor doc warnings that don't usually
get caught. I'm making this small change now so that I can turn on
warnings_as_errors in the enforcer script.

Change-Id: Ib0100116a4f7a38ad882d20a56ae99d15d49766a
This commit is contained in:
Brian Curtin 2017-04-05 10:23:37 -04:00
parent a4d75498b4
commit 442bed2658
4 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/users/index.rst
View File

@ -81,6 +81,7 @@ but listed below are the ones provided by this SDK by default.
Image v1 <proxies/image_v1> Image v1 <proxies/image_v1>
Image v2 <proxies/image_v2> Image v2 <proxies/image_v2>
Key Manager <proxies/key_manager> Key Manager <proxies/key_manager>
Load Balancer <proxies/load_balancer_v2>
Message v1 <proxies/message_v1> Message v1 <proxies/message_v1>
Message v2 <proxies/message_v2> Message v2 <proxies/message_v2>
Network <proxies/network> Network <proxies/network>

2
doc/source/users/proxies/telemetry.rst
View File

@ -6,7 +6,7 @@ Telemetry API
For details on how to use telemetry, see :doc:`/users/guides/telemetry` For details on how to use telemetry, see :doc:`/users/guides/telemetry`
.. automethod:: openstack.telemetry.v2._proxy .. automodule:: openstack.telemetry.v2._proxy
The Telemetry Class The Telemetry Class
------------------- -------------------

2
doc/source/users/proxies/workflow.rst
View File

@ -1,8 +1,6 @@
Workflow API Workflow API
============ ============
For details on how to use workflow, see :doc:`/users/guides/workflow`
.. automodule:: openstack.workflow.v2._proxy .. automodule:: openstack.workflow.v2._proxy
The Workflow Class The Workflow Class

3
openstack/cluster/v1/_proxy.py
View File

@ -1051,7 +1051,8 @@ class Proxy(proxy2.BaseProxy):
The resource must have a ``status`` attribute. The resource must have a ``status`` attribute.
:type resource: A :class:`~openstack.resource2.Resource` object. :type resource: A :class:`~openstack.resource2.Resource` object.
:param status: Desired status. :param status: Desired status.
:param list failures: Statuses that would be interpreted as failures. :param failures: Statuses that would be interpreted as failures.
:type failures: :py:class:`list`
:param interval: Number of seconds to wait before to consecutive :param interval: Number of seconds to wait before to consecutive
checks. Default to 2. checks. Default to 2.
:param wait: Maximum number of seconds to wait before the change. :param wait: Maximum number of seconds to wait before the change.