docs(spanner): update description of the timeout_secs parameter (#9381)

Closes #9364
googleapis · Oct 29, 2019 · ee62142 · ee62142
1 parent b2f28ca
commit ee62142
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git 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
@@ -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``.