Skip to content

chore: add docstring coverage and update docs version#230

Merged
shenxianpeng merged 1 commit into
mainfrom
codex/docstring-coverage-v1.4.2-docs
May 21, 2026
Merged

chore: add docstring coverage and update docs version#230
shenxianpeng merged 1 commit into
mainfrom
codex/docstring-coverage-v1.4.2-docs

Conversation

@shenxianpeng
Copy link
Copy Markdown
Member

Summary

  • Add missing module and function docstrings under cpp_linter_hooks to satisfy docstring coverage.
  • Update README and CMake example pre-commit rev references to v1.4.2 for the next release.

Validation

  • uv run ruff check
  • uv run ruff format --check
  • uv run pytest -q (113 passed)
  • AST docstring scan: 34/34 documented (100.00%)

Fixes #227

@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels May 21, 2026
@sonarqubecloud
Copy link
Copy Markdown

@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.07%. Comparing base (7fc3b20) to head (969742a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #230   +/-   ##
=======================================
  Coverage   97.07%   97.07%           
=======================================
  Files           4        4           
  Lines         239      239           
=======================================
  Hits          232      232           
  Misses          7        7           

☔ View full report in Codecov by Sentry.
📢 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 added maintenance Targets chores, refactors and cleanups and removed bug Something isn't working documentation Improvements or additions to documentation labels May 21, 2026
@shenxianpeng shenxianpeng changed the title [codex] Fix docstring coverage and update docs version chore: add docstring coverage and update docs version May 21, 2026
@shenxianpeng shenxianpeng marked this pull request as ready for review May 21, 2026 03:45
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

Warning

Rate limit exceeded

@shenxianpeng has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 33 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8fdf2a8d-cac7-4946-ace6-579690467466

📥 Commits

Reviewing files that changed from the base of the PR and between 7fc3b20 and 969742a.

📒 Files selected for processing (6)
  • README.md
  • cpp_linter_hooks/__init__.py
  • cpp_linter_hooks/clang_format.py
  • cpp_linter_hooks/clang_tidy.py
  • cpp_linter_hooks/util.py
  • examples/cmake/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docstring-coverage-v1.4.2-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@shenxianpeng shenxianpeng merged commit 31a75ea into main May 21, 2026
19 of 20 checks passed
@shenxianpeng shenxianpeng deleted the codex/docstring-coverage-v1.4.2-docs branch May 21, 2026 03:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Targets chores, refactors and cleanups

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docstring Coverage: write docstrings for the functions missing them

1 participant