mirror of https://github.com/astral-sh/ruff
Add docstrings for formatting
This commit is contained in:
parent
c3354ad843
commit
1337c4ad2a
|
|
@ -50,6 +50,9 @@ GITHUB_MAX_COMMENT_LENGTH = 65536 # characters
|
||||||
|
|
||||||
|
|
||||||
def markdown_check_result(result: Result) -> str:
|
def markdown_check_result(result: Result) -> str:
|
||||||
|
"""
|
||||||
|
Render a `ruff check` ecosystem check result as markdown.
|
||||||
|
"""
|
||||||
# Calculate the total number of rule changes
|
# Calculate the total number of rule changes
|
||||||
all_rule_changes = RuleChanges()
|
all_rule_changes = RuleChanges()
|
||||||
project_diffs = {
|
project_diffs = {
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,9 @@ if TYPE_CHECKING:
|
||||||
|
|
||||||
|
|
||||||
def markdown_format_result(result: Result) -> str:
|
def markdown_format_result(result: Result) -> str:
|
||||||
|
"""
|
||||||
|
Render a `ruff format` ecosystem check result as markdown.
|
||||||
|
"""
|
||||||
lines = []
|
lines = []
|
||||||
total_lines_removed = total_lines_added = 0
|
total_lines_removed = total_lines_added = 0
|
||||||
total_files_modified = 0
|
total_files_modified = 0
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue