small refactor of docstrings, unify quotation marks

src/tmt_web/generators/html_generator.py

@@ -4,14 +4,16 @@
 from jinja2 import Environment, FileSystemLoader
 from tmt import Logger, Plan, Test
 
-templ_dir = Path(__file__).resolve().parent / 'templates'
+templ_dir = Path(__file__).resolve().parent / "templates"
 
 env = Environment(loader=FileSystemLoader(str(templ_dir)), autoescape=True)
 
+
 def render_template(template_name: str, **kwargs) -> str:
     template = env.get_template(template_name)
     return template.render(**kwargs)
 
+
 def generate_status_callback(r: AsyncResult, status_callback_url: str) -> str:  # type: ignore [type-arg]
     data = {
         "status": r.status,
@@ -20,13 +22,16 @@ def generate_status_callback(r: AsyncResult, status_callback_url: str) -> str:
     }
     return render_template("status_callback.html.j2", **data)
 
+
 def generate_html_page(obj: Test | Plan, logger: Logger) -> str:
     logger.print("Generating the HTML file...")
-    return render_template('testorplan.html.j2', testorplan=obj)
+    return render_template("testorplan.html.j2", testorplan=obj)
+
 
 def generate_testplan_html_page(test: Test, plan: Plan, logger: Logger) -> str:
     logger.print("Generating the HTML file...")
-    return render_template('testandplan.html.j2', test=test, plan=plan)
+    return render_template("testandplan.html.j2", test=test, plan=plan)
+
 
 if __name__ == "__main__":
     print("This is not an executable file!")

src/tmt_web/generators/json_generator.py

@@ -7,7 +7,7 @@
 
 def _create_json_data(obj: Test | Plan, logger: tmt.Logger) -> dict[str, Any]:
     """
-    Helper function to create the JSON data from a test or plan object
+    Helper function to create the JSON data from a test or plan object.
     """
     full_url = obj.web_link()
     return {
@@ -31,7 +31,8 @@ def _create_json_data(obj: Test | Plan, logger: tmt.Logger) -> dict[str, Any]:
 
 def generate_test_json(test: tmt.Test, logger: tmt.Logger) -> str:
     """
-    This function generates an JSON file with the input data for a test
+    This function generates an JSON file with the input data for a test.
+
     :param test: Test object
     :param logger: tmt.Logger instance
     :return:
@@ -43,7 +44,8 @@ def generate_test_json(test: tmt.Test, logger: tmt.Logger) -> str:
 
 def generate_plan_json(plan: tmt.Plan, logger: tmt.Logger) -> str:
     """
-    This function generates an JSON file with the input data for a plan
+    This function generates an JSON file with the input data for a plan.
+
     :param plan: Plan object
     :param logger: tmt.Logger instance
     :return:
@@ -55,7 +57,8 @@ def generate_plan_json(plan: tmt.Plan, logger: tmt.Logger) -> str:
 
 def generate_testplan_json(test: tmt.Test, plan: tmt.Plan, logger: tmt.Logger) -> str:
     """
-    This function generates an JSON file with the input data for a test and a plan
+    This function generates an JSON file with the input data for a test and a plan.
+
     :param test: Test object
     :param plan: Plan object
     :param logger: tmt.Logger instance

src/tmt_web/generators/yaml_generator.py

@@ -10,7 +10,8 @@ def print_success(logger: Logger) -> None:
 
 def generate_test_yaml(test: tmt.Test, logger: Logger) -> str:
     """
-    This function generates an YAML file with the input data for a test
+    This function generates an YAML file with the input data for a test.
+
     :param test: Test object
     :param logger: tmt.Logger instance
     :return:
@@ -22,7 +23,8 @@ def generate_test_yaml(test: tmt.Test, logger: Logger) -> str:
 
 def generate_plan_yaml(plan: tmt.Plan, logger: Logger) -> str:
     """
-    This function generates an YAML file with the input data for a plan
+    This function generates an YAML file with the input data for a plan.
+
     :param plan: Plan object
     :param logger: tmt.Logger instance
     :return:
@@ -34,7 +36,8 @@ def generate_plan_yaml(plan: tmt.Plan, logger: Logger) -> str:
 
 def generate_testplan_yaml(test: tmt.Test, plan: tmt.Plan, logger: Logger) -> str:
     """
-    This function generates an YAML file with the input data for a test and a plan
+    This function generates an YAML file with the input data for a test and a plan.
+
     :param test: Test object
     :param plan: Plan object
     :param logger: tmt.Logger instance