Added a comment about the return from monitor_transactions

cedadev · Mar 8, 2023 · 0784597 · 0784597
1 parent 47fc525
commit 0784597
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/nlds_client/clientlib/transactions.py b/nlds_client/clientlib/transactions.py
@@ -699,6 +699,8 @@ def get_transaction_state(transaction: dict):
     """Get the overall state of a transaction in a more convienent form by 
     querying the sub-transactions and determining if the overall transaction 
     is complete.
+    transaction: a dictionary for a single transaction.  Note that 
+      monitor_transactions returns a dictionary of transactions
     Transaction dictionary looks like this:
     {
         'id': 2,