docs: refines doc strings for results reporting classes

Signed-off-by: Jennifer Power <[email protected]>

trestlebot/github.py

@@ -155,5 +155,6 @@ def is_github_actions() -> bool:
 
 
 def set_output(name: str, value: str) -> None:
+    """Set the output during the GitHub Actions workflow."""
     with open(os.environ["GITHUB_OUTPUT"], "a") as fh:
         print(f"{name}={value}", file=fh)  # noqa: T201

trestlebot/gitlab.py

@@ -105,9 +105,6 @@ class GitLabCIResultsReporter(ResultsReporter):
     def report_results(self, results: BotResults) -> None:
         """
         Report the results of the Trestle Bot in GitLab CI
-
-        Args:
-            results: BotResults object
         """
         results_str = ""
         if results.commit_sha:

trestlebot/reporter.py

@@ -22,7 +22,12 @@ class ResultsReporter:
     """
 
     def report_results(self, results: BotResults) -> None:
-        """Report the results of the Trestle Bot."""
+        """
+        Report the results of the Trestle Bot.
+
+        Args:
+            results: BotResults object
+        """
         results_str = ""
         if results.commit_sha:
             results_str += f"\nCommit Hash: {results.commit_sha}"
@@ -44,5 +49,6 @@ def get_changes_str(changes: List[str]) -> str:
 
         Notes: This method is starting off as a simple join of the changes list,
         but is intended to be expanded to provide more detailed information about the changes.
+        The goal is consistent representation.
         """
         return "\n".join(changes)