Skip to content

chore(README): update - #437

Merged
cclauss merged 2 commits into
developfrom
read-us
May 26, 2026
Merged

cclauss merged 2 commits into
developfrom
read-us

Conversation

@aaronliu0130

@aaronliu0130 aaronliu0130 commented May 24, 2026 •

Copy link
Copy Markdown
Member

nod to uv tool install and precommit in installation

update list of changes
(removed JUnit format mention due to #431)

use comment for user to select their own instead of hardcoding any version number and clogging up the file history

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to use uv tool instead of pipx for installing cpplint.
    • Refreshed feature documentation highlighting Python 3 compatibility, enhanced extension support, CI integration, exclude functionality, NOLINT block skipping, and modern C++ features support.

Review Change Stack

nod to `uv tool install` and `precommit` in installation
update list of changes
(removed JUnit format mention due to #431)
use comment for user to select their own instead of hardcoding any version number and clogging up the file history
@aaronliu0130
aaronliu0130 requested a review from cclauss May 24, 2026 23:24
@coderabbitai

coderabbitai Bot commented May 24, 2026 •

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

README.rst installation instructions were updated to recommend uv for installing cpplint with an expanded pre-commit hook example. The "Changes" section was rewritten to document current features like --exclude, --extensions, --recursive, and NOLINT block support, replacing older changelog items.

Changes

README Documentation Refresh

Layer / File(s) Summary
Installation instructions and feature changelog
README.rst
Installation guidance now promotes uv tool install cpplint over pipx, with a complete pre-commit hook example including configurable args. Feature changelog rewritten to highlight Python 3 compatibility, exclude/extensions support, recursive discovery, NOLINT blocks (// NOLINTBEGIN/// NOLINTEND), and GitHub CI integration.

🎯 1 (Trivial) | ⏱️ ~5 minutes

A rabbit hopped through the docs with care,
Updating tools that users share—
From pipx to uv, the path is clear,
With features new, both far and near! 🐇✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'chore(README): update' is vague and generic, using a non-descriptive term that doesn't convey meaningful information about the specific changes made. Use a more specific title that highlights the key changes, such as 'chore(README): update installation instructions for uv tool and modernize changelog' or similar.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch read-us

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.rst`:
- Line 47: Replace the empty rev placeholder so the example config is runnable:
update the `rev:` entry in README.rst (the `rev` placeholder line) to a concrete
placeholder string such as `rev: "vX.Y.Z"` or `rev: "latest"` so users have a
valid default to copy and replace; ensure the placeholder is quoted and clearly
annotated (e.g., `rev: "vX.Y.Z"  # replace with actual cpplint tag`) so it
parses in pre-commit.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 24cb8293-3440-4c8a-a103-ab06c6216884

📥 Commits

Reviewing files that changed from the base of the PR and between e49bf22 and 04f7d7e.

📒 Files selected for processing (1)
  • README.rst

Comment thread README.rst
.. code-block:: yaml

- repo: https://github.com/cpplint/cpplint
rev: # cpplint version number or git tag

@coderabbitai coderabbitai Bot May 24, 2026 •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Use a valid rev placeholder instead of an empty value.

Line 47 currently leaves rev: empty, so the pasted config won’t run in pre-commit. Use a concrete placeholder string users can replace.

Suggested doc fix
   - repo: https://github.com/cpplint/cpplint
-    rev:  # cpplint version number or git tag
+    rev: vX.Y.Z  # replace with a cpplint release tag you want to pin
     hooks:
       - id: cpplint
         args:
           - --filter=-whitespace/line_length,-whitespace/parens
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
rev: # cpplint version number or git tag
- repo: https://github.com/cpplint/cpplint
rev: vX.Y.Z # replace with a cpplint release tag you want to pin
hooks:
- id: cpplint
args:
- --filter=-whitespace/line_length,-whitespace/parens
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.rst` at line 47, Replace the empty rev placeholder so the example
config is runnable: update the `rev:` entry in README.rst (the `rev` placeholder
line) to a concrete placeholder string such as `rev: "vX.Y.Z"` or `rev:
"latest"` so users have a valid default to copy and replace; ensure the
placeholder is quoted and clearly annotated (e.g., `rev: "vX.Y.Z"  # replace
with actual cpplint tag`) so it parses in pre-commit.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion doesn't run either, and the point is that users need to replace the comment with an actual version number of their choosing.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aaronliu0130, you're right — rev: vX.Y.Z would fail for the same reason. The inline comment makes the intent clear, and the PR's stated goal of avoiding hardcoded version numbers in the README is a reasonable trade-off. I'll withdraw this suggestion.

( ˘︹˘ ) rabbit concedes the point


✏️ Learnings added
Learnt from: aaronliu0130
Repo: cpplint/cpplint PR: 437
File: README.rst:47-47
Timestamp: 2026-05-25T23:32:47.025Z
Learning: In the cpplint README.rst pre-commit hook example (file: README.rst), the `rev:` field is intentionally left empty with an inline comment (`# cpplint version number or git tag`). This is a deliberate design choice to avoid hardcoding version numbers in the README and cluttering file history; users are expected to fill in the version themselves. Do not flag the empty `rev:` as an issue.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@cclauss
cclauss merged commit fa09262 into develop May 26, 2026
12 checks passed
@cclauss
cclauss deleted the read-us branch May 26, 2026 10:19

This branch was previously deployed

1 inactive deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants