openstack
/
openstacksdk
Code Issues Proposed changes

Fix wait_for_server docstring 

There is no 'res' parameter. While we're in there, fix the indentation.

Change-Id: Ib9d13ec18177bf2fb436a42c81b5776ad8248818
This commit is contained in:
Monty Taylor 2019-03-18 14:17:31 +00:00
parent 16f2dbe3b0
commit 4b89bc2592
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
openstack/compute/v2/_proxy.py
View File

@ -930,16 +930,20 @@ class Proxy(proxy.Proxy):
interval=2, wait=120):
"""Wait for a server to be in a particular status.
:param res: The resource to wait on to reach the specified status.
The resource must have a ``status`` attribute.
:type resource: A :class:`~openstack.resource.Resource` object.
:param server:
The :class:`~openstack.compute.v2.server.Server` to wait on
to reach the specified status.
:type server: :class:`~openstack.compute.v2.server.Server`:
:param status: Desired status.
:param 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
checks. Default to 2.
:param wait: Maximum number of seconds to wait before the change.
Default to 120.
:param int interval:
Number of seconds to wait before to consecutive checks.
Default to 2.
:param int wait:
Maximum number of seconds to wait before the change.
Default to 120.
:returns: The resource is returned on success.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if transition
to the desired status failed to occur in specified seconds.