From 5be40c5db1be13bc128dea23e63d980afd5b79a1 Mon Sep 17 00:00:00 2001
From: Sebastian Engel <dev@sebastianengel.eu>
Date: Mon, 29 Apr 2024 19:00:37 +0200
Subject: [PATCH] fix(node_executor): improve docstrngs

---
 contents/salt_node_executor.py | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/contents/salt_node_executor.py b/contents/salt_node_executor.py
index 1cfca13..d06308c 100644
--- a/contents/salt_node_executor.py
+++ b/contents/salt_node_executor.py
@@ -11,6 +11,11 @@
 
 
 def main():
+    """
+    Main function to execute remote commands via Salt-API
+
+    This function retrieves necessary data from environment variables provided by Rundeck.
+    """
     # parse environment provided by rundeck
     data_items = [
         DataItem('cmd', 'RD_EXEC_COMMAND', 'str'),
@@ -61,11 +66,10 @@ def main():
         'tgt': data['host'],
         'fun': 'cmd.run',
         'arg': args,
-        # full return to get retcode
-        'full_return': True,
+        'full_return': True,  # full return to get retcode
     }
 
-    # login to api
+    # login to the API
     client = Pepper(api_url=data['url'], ignore_ssl_errors=not data['verify_ssl'])
     try:
         response = client.login(username=data['user'], password=data['password'], eauth=data['eauth'])
@@ -74,7 +78,7 @@ def main():
         sys.exit(1)
     log.debug(f'Logging into API: {response}')
 
-    # sending payload
+    # send payload
     try:
         response = client.low(lowstate=[low_state])
     except PepperException as exception:
@@ -87,7 +91,7 @@ def main():
     data = minion_response.get('ret', 'No response received')
     return_code = minion_response.get('retcode', 1)
 
-    # rundeck reads stdout
+    # print response to stdout for Rundeck to pickup
     print(data)
 
     # rundeck reads return code