From 1337c4ad2a699824a620e584cd6cedb588d67ca9 Mon Sep 17 00:00:00 2001 From: Zanie Date: Fri, 27 Oct 2023 12:49:29 -0500 Subject: [PATCH] Add docstrings for formatting --- python/ruff-ecosystem/ruff_ecosystem/check.py | 3 +++ python/ruff-ecosystem/ruff_ecosystem/format.py | 3 +++ 2 files changed, 6 insertions(+) diff --git a/python/ruff-ecosystem/ruff_ecosystem/check.py b/python/ruff-ecosystem/ruff_ecosystem/check.py index b783ca5d0a..5ad209af01 100644 --- a/python/ruff-ecosystem/ruff_ecosystem/check.py +++ b/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 = { diff --git a/python/ruff-ecosystem/ruff_ecosystem/format.py b/python/ruff-ecosystem/ruff_ecosystem/format.py index 60cd30e60e..9471622038 100644 --- a/python/ruff-ecosystem/ruff_ecosystem/format.py +++ b/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