From c7973cb449700ef2a9e917214c1cf4b05570bcc3 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Tue, 15 Aug 2017 10:59:53 -0400 Subject: [PATCH] doc/rados/api/python document required_state manually Signed-off-by: Alfredo Deza --- doc/rados/api/python.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/rados/api/python.rst b/doc/rados/api/python.rst index 6073a61648f..d7555686b0b 100644 --- a/doc/rados/api/python.rst +++ b/doc/rados/api/python.rst @@ -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 -- 2.39.5