Skip to content

docs: update clang-tidy wheel range and hook return values - #300

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-g81fbm
Oct 18, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-g81fbm

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 18, 2026 •

Copy link
Copy Markdown
Member

Summary

Docs/code consistency pass.

  • README.md: clang-tidy wheels now go up to LLVM 23 (23.1.3 is on PyPI), not 22.
  • AGENTS.md: the -1 return code for --dry-run was removed earlier (0ca532e). Hooks now return the tool's exit code, and --dry-run adds --Werror so formatting issues fail. Updated the description to match clang_format.py / clang_tidy.py.

Related Issues

None.

Summary by CodeRabbit

  • Documentation
    • Clarified that hooks return a result and output, with exit code 0 indicating success.
    • Documented that --dry-run also enables --Werror, so formatting issues cause failure.
    • Updated the documented maximum clang-tidy wheel version to LLVM 23.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 18, 2026
@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (29a4d7b) to head (8ace80d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #300   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          248       248           
=========================================
  Hits           248       248           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shenxianpeng
shenxianpeng merged commit 67e94f2 into main Oct 18, 2026
33 of 34 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-g81fbm branch October 18, 2026 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant