From: Lee Yarwood <lyarwood@redhat.com>
Date: Tue, 20 Apr 2021 09:59:29 +0000 (+0100)
Subject: pybind/rados: Document that timeout arg is ignored by connect
X-Git-Tag: v17.1.0~2184^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=79fca7aaf1012d9b6b6ee9433baf4f18f268e037;p=ceph.git

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 86f887fd672..4a5db349516 100644
--- 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,