From ee6214251fbe83cb83a9b5b5019c605a27a01354 Mon Sep 17 00:00:00 2001 From: Leonid Emar-Kar <46078689+Emar-Kar@users.noreply.github.com> Date: Tue, 29 Oct 2019 22:01:22 +0300 Subject: [PATCH] docs(spanner): update description of the timeout_secs parameter (#9381) Closes #9364 --- spanner/google/cloud/spanner_v1/database.py | 5 +++-- spanner/google/cloud/spanner_v1/session.py | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/spanner/google/cloud/spanner_v1/database.py b/spanner/google/cloud/spanner_v1/database.py index 48698e4d73e2..f561ecd4fa9e 100644 --- a/spanner/google/cloud/spanner_v1/database.py +++ b/spanner/google/cloud/spanner_v1/database.py @@ -419,9 +419,10 @@ def run_in_transaction(self, func, *args, **kw): :param args: additional positional arguments to be passed to ``func``. :type kw: dict - :param kw: optional keyword arguments to be passed to ``func``. + :param kw: (Optional) keyword arguments to be passed to ``func``. If passed, "timeout_secs" will be removed and used to - override the default timeout. + override the default retry timeout which defines maximum timestamp + to continue retrying the transaction. :rtype: Any :returns: The return value of ``func``. diff --git a/spanner/google/cloud/spanner_v1/session.py b/spanner/google/cloud/spanner_v1/session.py index 4685c8b80137..f8e7e88d9731 100644 --- a/spanner/google/cloud/spanner_v1/session.py +++ b/spanner/google/cloud/spanner_v1/session.py @@ -273,9 +273,10 @@ def run_in_transaction(self, func, *args, **kw): :param args: additional positional arguments to be passed to ``func``. :type kw: dict - :param kw: optional keyword arguments to be passed to ``func``. + :param kw: (Optional) keyword arguments to be passed to ``func``. If passed, "timeout_secs" will be removed and used to - override the default timeout. + override the default retry timeout which defines maximum timestamp + to continue retrying the transaction. :rtype: Any :returns: The return value of ``func``.