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>
This commit is contained in:
Lee Yarwood 2021-04-20 10:59:29 +01:00
parent 477b705fe7
commit 79fca7aaf1

View File

@ -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,