openstack/python-openstackclient
Code Issues Proposed changes

Trivial: Fix wrong doc for wait_for_status().

Browse Source 
Two trivial fixes:
1. docs for parameters are not sorted correctly
2. missing doc for a parameter

Change-Id: I0cfb65e0f897c391b9b6e7225251e88855b07a56
This commit is contained in:
Tang Chen 2015-11-21 19:33:14 +08:00
parent 65e6c7bc63
commit 6957fb3ee7
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
openstackclient/common/utils.py
View File

@ -305,8 +305,9 @@ def wait_for_status(status_f,
:param status_f: a status function that takes a single id argument
:param res_id: the resource id to watch
:param success_status: a list of status strings for successful completion
:param status_field: the status attribute in the returned resource object
:param success_status: a list of status strings for successful completion
:param error_status: a list of status strings for error
:param sleep_time: wait this long (seconds)
:param callback: called per sleep cycle, useful to display progress
:rtype: True on success