From 5a8e8efb94b6c7e477eea5ecedfb13792c15159a Mon Sep 17 00:00:00 2001
From: Katleho Madisa <katleho.madisa47@gmail.com>
Date: Fri, 18 Sep 2020 13:17:25 +0000
Subject: [PATCH] SAR-149 Updated docstring.
---
src/ska/logging/transactions.py | 42 ++++++++++++++++-----------------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/src/ska/logging/transactions.py b/src/ska/logging/transactions.py
index 5a5e163..7aa6a2e 100644
--- a/src/ska/logging/transactions.py
+++ b/src/ska/logging/transactions.py
@@ -22,30 +22,30 @@ class Transaction:
.. Examples::
- def command(self, parameter_json):
- parameters = json.reads(parameter_json)
- with ska.logging.transaction('My Command', parameters) as transaction_id:
- # ...
- parameters['transaction_id'] = transaction_id
- device.further_command(json.dumps(pars))
- # ...
+ def command(self, parameter_json):
+ parameters = json.reads(parameter_json)
+ with ska.logging.transaction('My Command', parameters) as transaction_id:
+ # ...
+ parameters['transaction_id'] = transaction_id
+ device.further_command(json.dumps(pars))
+ # ...
def command(self, parameter_json):
- parameters = json.reads(parameter_json)
- with ska.logging.transaction('My Command', parameters, transaction_id = "123") as transaction_id:
- # ...
- parameters['transaction_id'] = transaction_id
- device.further_command(json.dumps(pars))
- # ...
+ parameters = json.reads(parameter_json)
+ with ska.logging.transaction('My Command', parameters, transaction_id="123") as transaction_id:
+ # ...
+ parameters['transaction_id'] = transaction_id
+ device.further_command(json.dumps(pars))
+ # ...
def command(self, parameter_json):
- parameters = json.reads(parameter_json)
- parameters["txn_id_key"] = 123
- with ska.logging.transaction('My Command', parameters, transaction_id_key = "txn_id_key") as transaction_id:
- # ...
- parameters['transaction_id'] = transaction_id
- device.further_command(json.dumps(pars))
- # ...
+ parameters = json.reads(parameter_json)
+ parameters["txn_id_key"] = 123
+ with ska.logging.transaction('My Command', parameters, transaction_id_key="txn_id_key") as transaction_id:
+ # ...
+ parameters['transaction_id'] = transaction_id
+ device.further_command(json.dumps(pars))
+ # ...
Log message formats:
On Entry:
@@ -55,7 +55,7 @@ class Transaction:
On exception:
Transaction [id]: Exception [name]
Stacktrace
- """
+ """
def __init__(
self,
--
GitLab