Skip to content
Snippets Groups Projects
Unverified Commit fc5a9bb5 authored by Katleho Madisa's avatar Katleho Madisa
Browse files

SAR-149 Updated docstrings.

parent 07f4ac46
No related branches found
No related tags found
No related merge requests found
...@@ -73,6 +73,9 @@ class Transaction: ...@@ -73,6 +73,9 @@ class Transaction:
If there is a transaction ID in `params` and `transaction_id` is also passed in If there is a transaction ID in `params` and `transaction_id` is also passed in
then the passed in `transaction_id` will take precedence. then the passed in `transaction_id` will take precedence.
However, if both transaction IDs provided in `params` and `transaction_id` are deemed
invalid (not a string or an empty string), then a new transaction ID will be generated.
By default the key `transaction_id` will be used to get a transaction ID out of By default the key `transaction_id` will be used to get a transaction ID out of
`params`. If a different key is required then `transaction_id_key` can be `params`. If a different key is required then `transaction_id_key` can be
specified. specified.
...@@ -96,12 +99,11 @@ class Transaction: ...@@ -96,12 +99,11 @@ class Transaction:
Raises Raises
------ ------
TransactionParamsError TransactionParamsError
If the `params` passed in is not valid. If the `params` passed is not valid.
""" """
if not isinstance(params, Mapping): if not isinstance(params, Mapping):
raise TransactionParamsError("params must be dict-like (Mapping)") raise TransactionParamsError("params must be dict-like (Mapping)")
if logger: if logger:
self.logger = logger self.logger = logger
else: else:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment