Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spanner: Update docs for timeout_secs param in Database.run_in_transaction() #9364

Closed
skuruppu opened this issue Oct 1, 2019 · 0 comments · Fixed by #9381
Closed

Spanner: Update docs for timeout_secs param in Database.run_in_transaction() #9364

skuruppu opened this issue Oct 1, 2019 · 0 comments · Fixed by #9381
Assignees
Labels
api: spanner Issues related to the Spanner API. type: docs Improvement to the documentation for an API.

Comments

@skuruppu
Copy link
Contributor

skuruppu commented Oct 1, 2019

The documentation for Database.run_in_transaction() states:

:param kw: optional keyword arguments to be passed to ``func``.
           If passed, "timeout_secs" will be removed and used to
           override the default timeout.

Based on the SO issue the documentation is misleading because users will assume that timeout_secs is the deadline for the request. Instead, this parameter is the retry timeout which is the deadline after which the transaction will stop being retried.

We need to update the documentation so that it's clear what this parameter is used for.

@HemangChothani HemangChothani added api: spanner Issues related to the Spanner API. type: docs Improvement to the documentation for an API. labels Oct 1, 2019
@emar-kar emar-kar self-assigned this Oct 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: spanner Issues related to the Spanner API. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants