RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-29 14:34:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/rados/api/python document required_state manually

Browse Source 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
This commit is contained in:
Alfredo Deza 2017-08-15 10:59:53 -04:00
parent 88a1114cb3
commit c7973cb449
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/rados/api/python.rst
View File

@ -280,12 +280,22 @@ the cluster ``fsid``, retrieve cluster statistics, and disconnect (shutdown)
from the cluster. You may also assert that the cluster handle is in a particular
state (e.g., "configuring", "connecting", etc.).
.. automethod:: Rados.connect(timeout=0)
.. automethod:: Rados.shutdown()
.. automethod:: Rados.get_fsid()
.. automethod:: Rados.get_cluster_stats()
.. automethod:: Rados.require_state()
.. documented manually because it raises warnings because of *args usage in the
.. signature
.. py:class:: Rados
.. py:method:: require_state(*args)
Checks if the Rados object is in a special state
:param args: Any number of states to check as separate arguments
:raises: :class:`RadosStateError`
Pool Operations