pybind/rados: Document that timeout arg is ignored by connect

While this argument is accepted it has always been ignored. To avoid
confusion it should at least be called out in the documentation.

Signed-off-by: Lee Yarwood <lyarwood@redhat.com>

diff --git a/src/pybind/rados/rados.pyx b/src/pybind/rados/rados.pyx
index 86f887fd672eb9d81a6535cbd2f9cdcb514aa052..4a5db34951646a5d592c8bc3c74c7add5c8da294 100644 (file)
--- a/src/pybind/rados/rados.pyx
+++ b/src/pybind/rados/rados.pyx
@@ -660,6 +660,8 @@ Rados object in state %s." % self.state)
     def connect(self, timeout: int = 0):
         """
         Connect to the cluster.  Use shutdown() to release resources.
+
+        :param timeout: Any supplied timeout value is currently ignored.
         """
         self.require_state("configuring")
         # NOTE(sileht): timeout was supported by old python API,