MAINT: minor changes

- declared feature experimental
- removed outdated TODOs
- comment styling

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added ###
 
 - `generic_analysis.py` allows to easily call scripts to perform analyses in
-  server side scripting
+  server side scripting [EXPERIMENTAL]
 
 ### Changed ###
 

src/caosadvancedtools/serverside/generic_analysis.py

@@ -134,7 +134,7 @@ def call_script(script_name: str, record_id: int):
     ret = run_server_side_script(script_name, record_id)
 
     if ret.code != 0:
-        logger.error("Script failed")
+        logger.error("Script failed!")
         logger.debug(ret.stdout)
         logger.error(ret.stderr)
     else:
@@ -161,9 +161,6 @@ def run(dataAnalysisRecord: db.Record):
     said for the python package holds here.
     """
 
-    # TODO enhance datamodel? 'Software' Property that references 'Script' or
-    # Python module?
-
     if dataAnalysisRecord.get_property("scripts") is not None:
         script_name = check_referenced_script(dataAnalysisRecord)
         logger.debug(
@@ -190,8 +187,7 @@ def run(dataAnalysisRecord: db.Record):
 
 
 def _parse_arguments():
-    """Parses the command line arguments.
-    """
+    """ Parses the command line arguments.  """
     parser = argparse.ArgumentParser(description='__doc__')
     parser.add_argument("--module", help="An id an input dataset.")
     parser.add_argument("--inputset", help="An id an input dataset.")
@@ -201,6 +197,7 @@ def _parse_arguments():
 
 
 def main():
+    """ This is for testing only. """
     args = _parse_arguments()
 
     dataAnalysisRecord = db.Record()
@@ -208,7 +205,6 @@ def main():
     dataAnalysisRecord.add_property(name="ParameterSet", value=args.parameter)
     dataAnalysisRecord.add_property(name="Software", value=args.module)
 
-    # TODO: should this be done?
     dataAnalysisRecord.insert()
     run(dataAnalysisRecord)