Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: complain about catch-alls documenting alarm (sub) codes #280

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

ci: complain about catch-alls documenting alarm (sub) codes #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5768f63
ci: include alarm name in catch-all warning message
gavanderhoorn Jul 17, 2024
53cf8c2
ci: warn about alarms only documented by catch-alls
gavanderhoorn Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .ci/alarm_subcode_doc_linter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def main():
)
if doc_range:
if doc_range.is_catch_all and args.warn_catch_alls:
print(f"{sdef.loc_str}: warning: documented by catch-all '{doc_range}'")
print(f"{sdef.loc_str}: warning: '{sdef}' documented by catch-all '{doc_range}'")
else:
ret = 1
print(f"{sdef.loc_str}: error: no documentation for '{sdef}' in '{args.md_file}'")
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/ci_check_subcode_docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ jobs:
python \
.ci/alarm_subcode_doc_linter.py \
--check-all \
--warn-catch-alls \
--ignore-enum Failed_Trajectory_Status \
--ignore-enum Init_Trajectory_Status \
--ignore-enum MotionNotReadyCode \
Expand Down
Loading