adressed comments

Signed-off-by: Helge Wehder <[email protected]>

Author: myteron

docs/Secure-Coding-Guide-for-Python/CWE-693/CWE-798/README.md

@@ -35,42 +35,42 @@ The `noncompliant01.py` code `front_end` method simulates our front-end service
 ```py
 # SPDX-FileCopyrightText: OpenSSF project contributors
 # SPDX-License-Identifier: MIT
-""" Non-compliant Code Example """
+"""Non-compliant Code Example"""
+
 import logging
 import unittest
- 
+
 logging.basicConfig(encoding="utf-8", level=logging.DEBUG)
- 
- 
+
+
 def front_end():
-    """Dummy method demonstrating noncompliant implementation"""
+    """Simulating front end implementation"""
     # A noncompliant implementation would typically hardcode server_config
     # and load it from a project global python file or variable
     server_config = {}
     server_config["IP"] = "192.168.0.1"
     server_config["PORT"] = "192.168.0.1"
     server_config["USER"] = "admin"
     server_config["PASS"] = "SuperSecret123"
- 
+
     # it would then use the configuration
     logging.debug("connecting to server IP %s", server_config["IP"])
     logging.debug("connecting to server PORT %s", server_config["IP"])
     logging.debug("connecting to server USER %s", server_config["USER"])
     logging.debug("connecting to server PASS %s", server_config["PASS"])
- 
- 
+
+
 class TestSimulateDeployingFrontEnd(unittest.TestCase):
     """
     Simulate the deployment starting the front_end to connect
     to the backend
     """
- 
+
     def test_front_end(self):
         """Verifiy front_end implementation"""
         front_end()
- 
- 
- 
+
+
 if __name__ == "__main__":
     unittest.main()
 ```
@@ -94,11 +94,10 @@ The `compliant01.py` code is using a `config.ini` file that is created by the de
 *[compliant01.py](compliant01.py):*
 
 ```python
-""" Compliant Code Example """
 # SPDX-FileCopyrightText: OpenSSF project contributors
 # SPDX-License-Identifier: MIT
 """ Compliant Code Example """
-import logging
+
 from pathlib import Path
 import unittest
 import configparser
@@ -107,8 +106,7 @@ logging.basicConfig(encoding="utf-8", level=logging.DEBUG)
 
 
 def front_end(config_file_path: Path):
-    """Dummy method demonstrating noncompliant implementation"""
-    # A compliant loads connection information from a well protect file
+    """Simulating front end implementation"""
     _config = configparser.ConfigParser()
     _config.read(config_file_path)
 

docs/Secure-Coding-Guide-for-Python/CWE-693/CWE-798/compliant01.py

@@ -11,7 +11,7 @@
 
 
 def front_end(config_file_path: Path):
-    """Dummy method demonstrating noncompliant implementation"""
+    """Simulating front end implementation"""
     # A compliant loads connection information from a well protect file
     _config = configparser.ConfigParser()
     _config.read(config_file_path)