doc/rados/api/python document required_state manually

Signed-off-by: Alfredo Deza <adeza@redhat.com>

diff --git a/doc/rados/api/python.rst b/doc/rados/api/python.rst
index 6073a61648f09c14ad92602e42c05c0d1fe378ae..d7555686b0be0236a60fd0cf8ad0221ee17b4b78 100644 (file)
--- 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