amacocian/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2026-07-15 15:19:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Codechange: [CI] Give examples in errors in file description checker. (#15366)

Browse Source
This commit is contained in:
Cyprian Klimaszewski
2026-03-23 13:32:03 +01:00
committed by GitHub
parent 4b40c1fefb
commit 9abaf555a0
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/file-descriptions.py
+13 -11
View File
@@ -48,19 +48,21 @@ def check_descriptions(files):
with open(path, "r") as f:
content = f.read()
ann = content.find(f"@file {name} ")
reason = f'Should be of the form "/** @file {name} Brief description of the file here. */"'
if ann == -1:
if content.find("@file") == -1:
errors.append(f'File "{path}" does not provide description.')
else:
errors.append(f'Description of file "{path}" does not match coding style.')
continue
end = content.find("\n", ann)
start = content.rfind("\n", 0, ann) + 1
if content[start : ann] == "/** " and content[end - 3 : end] == " */" and content[end - 4] in END_OF_SENTENCE:
continue
elif content[start : ann] == " * " and content[start - 4 : start - 1] == "/**" and content[end - 1] in END_OF_SENTENCE and content[end + 1 : end + 4] != " */":
continue
errors.append(f'Description of file "{path}" does not match coding style.')
errors.append(f'File "{path}" does not provide description. {reason}')
continue
else:
end = content.find("\n", ann)
start = content.rfind("\n", 0, ann) + 1
if content[start : ann] == "/** " and content[end - 3 : end] == " */" and content[end - 4] in END_OF_SENTENCE:
continue
elif content[start : ann] == " * ":
if content[start - 4 : start - 1] == "/**" and content[end - 1] in END_OF_SENTENCE and content[end + 1 : end + 4] != " */":
continue
reason = f"Should be of the form:\n/**\n * @file {name} Brief description of the file here.\n * Detailed description of the file here.\n */"
errors.append(f'Description of file "{path}" does not match coding style. {reason}')
return errors