chore(docs): update docstrings for batches without context managers #578
+60
−13
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #447
The library uses context managers to make transaction/batch lifecycle management easier. When in a context manager, all client.get calls will target the active transaciton, and commit/rollback is called automatically when complete
You can also manage the lifecycle explicitly, but you have to manually pass in the transaction when doing client.get calls to avoid contention exceptions.
This PR updates the docstrings to make the contention issue more clear, and adds a test using transactions without context managers