Add docstrings for formatting

python/ruff-ecosystem/ruff_ecosystem/check.py

@@ -50,6 +50,9 @@ GITHUB_MAX_COMMENT_LENGTH = 65536  # characters
 
 
 def markdown_check_result(result: Result) -> str:
+    """
+    Render a `ruff check` ecosystem check result as markdown.
+    """
     # Calculate the total number of rule changes
     all_rule_changes = RuleChanges()
     project_diffs = {

python/ruff-ecosystem/ruff_ecosystem/format.py

@@ -22,6 +22,9 @@ if TYPE_CHECKING:
 
 
 def markdown_format_result(result: Result) -> str:
+    """
+    Render a `ruff format` ecosystem check result as markdown.
+    """
     lines = []
     total_lines_removed = total_lines_added = 0
     total_files_modified = 0