README.rst: Do minor cleanup and add self as a maintainer by cclauss · Pull Request #434 · cpplint/cpplint

cclauss · 2026-04-19T05:53:38Z

Summary by CodeRabbit

Documentation
- Updated project description to note a friendly fork and clarified status of upstream PRs/issues
- Added an alternative uv-based installation option and formatted the existing pipx reference as a link
- Bumped documented pre-commit hook revision to 2.0.2
- Reformatted the Changes list (title-casing, inline option formatting) and reorganized entries
- Added a new maintainer to the list

coderabbitai · 2026-04-19T05:53:49Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 53669e95-e74c-4ad6-9d33-679cb1ded729

📥 Commits

Reviewing files that changed from the base of the PR and between dd2490c and 3b8e94d.

📒 Files selected for processing (1)

README.rst

🚧 Files skipped from review as they are similar to previous changes (1)

README.rst

📝 Walkthrough

Walkthrough

README.rst wording and formatting updated: project origin rephrased to "friendly fork"; installation adds uv-based alternative; pre-commit hook rev bumped to 2.0.2; Change bullets reformatted and option flags inlined; a maintainer entry added.

Changes

Cohort / File(s)	Summary
Documentation `README.rst`	Reworded project origin to "friendly fork"; added `uv tool install cpplint` as an alternative install method and converted `pipx` reference to a link; bumped pre-commit hook `rev` from `2.0.0` to `2.0.2`; reordered and title-cased Change bullets; converted option names to inline code (e.g., `--exclude`, `--extensions`, `--recursive`); added a maintainer entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I nibbled lines and hopped to fork,
Swapped phrasing soft, adjusted talk,
Added uv to the install walk,
Bumped the rev, inlined each flag,
A tiny hop — README wagged its tail and wag.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: README.rst documentation cleanup and adding the author (`@cclauss`) as a maintainer.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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 add-cclauss-as-maintainer

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.rst`:
- Line 28: The sentence in README.rst that currently reads "pretty much
everything in their repo's PRs and issues about cpplint have gone
unimplemented." is grammatically awkward; update that exact sentence to use
correct agreement and clarity—either change "have" to "has" ("...have gone
unimplemented" → "...has gone unimplemented") or rephrase to "many PRs/issues
remain unimplemented" to improve readability and correctness while preserving
the original meaning.
- Around line 42-47: Replace the Markdown-style link
`[uv](https://docs.astral.sh/uv)` in the "Or use ..." sentence with
reStructuredText inline link syntax (e.g., use `uv <https://docs.astral.sh/uv>`_
form) so the link renders correctly in .rst consumers; update the sentence that
mentions the uv documentation link and keep the surrounding code block (`$ uv
tool install cpplint`) unchanged.

🪄 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: 673ab27f-3483-43ac-a319-1b9bc94632ef

📥 Commits

Reviewing files that changed from the base of the PR and between 039713b and 199cc57.

📒 Files selected for processing (1)

README.rst

Copilot

Pull request overview

Updates README.rst to reflect the fork’s current maintenance status and refresh installation/usage documentation.

Changes:

Refines the project description and maintenance status wording.
Adds uv as an alternative installation method alongside pipx.
Updates examples (pre-commit rev bump, refreshed “Changes” list) and adds a maintainer entry.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

aaronliu0130

just some minor things!

aaronliu0130 · 2026-04-19T15:25:21Z


  - repo: https://github.com/cpplint/cpplint
-    rev: 2.0.0
+    rev: 2.0.2


I don't like the implication that we'll have to update a version number in the README every release. Maybe we could pin this to a version number significant to us, or just make it like this:?

Suggested change

rev: 2.0.2

rev: # cpplint version number

Nope. That is not usable out-of-the-box.

I don't see why it has to be. It's very clear how it can be usable out-of-the-box. READMEs are usually quite static.

Let's agree to disagree. Repos occasionally do pre-commit autoupdate but I am OK for them to use an older version until they do so.

Should we add a step in our release process to update the README?

I am OK for them to use an older version until they do so.

Alright, let's

pin this to a version number significant to us

, then. I personally want to pin it at the next release (I'm thinking of making it 2.1.0. We should be able to to do the release process after the currently open PRs are merged, which shouldn't take too long and we can wait for. Even #426 where the PR creator hasn't responded I should be able to fix up quickly) because of how wide the namespace indentation false positives it fixes are.

I do not want to bump it every release, as you suggest, though. That clogs up the README's file history without introducing new information.

aaronliu0130 · 2026-04-19T15:34:39Z

+Use `pipx <https://pipx.pypa.io>`_ to install cpplint from PyPI, run:

 .. code-block:: bash

    $ pipx install cpplint

+Or use `uv <https://docs.astral.sh/uv>`_ to install cpplint from PyPI, run:


Suggested change

Use `pipx <https://pipx.pypa.io>`_ to install cpplint from PyPI, run:

.. code-block:: bash

$ pipx install cpplint

Or use `uv <https://docs.astral.sh/uv>`_ to install cpplint from PyPI, run:

To use `uv <https://docs.astral.sh/uv>`_ to install cpplint from PyPI as a tool, run:

Methinks pipx is a little outmoded

Since it's just a PyPI package name, I think just doing one PyPI-compliant tool is enough unless it can trigger some special hijinks. I don't want this to attract flies that try to add every PyPI tool in existence.

pipx comes from the Python Packaging Authority, like pip does, so some people may trust it more.

uv was recently purchased by OpenAI, which some people might not trust in their daily toolchain.

I think we can trust users to select the tool that they'd like, and it's clear enough that cpplint is the package name on PyPI to feed into the tool that they'd like.

Why are you blocking progress over this?

i'm not; this is the smallest thing among all my comments here. I won't block because of this as long as 1. we go "to use" instead of "use" for grammar 2. the other things above are resolved.

TL;DR: I'm blocking because of the version number–bumping precedent this is setting for the hook, not this.

Use this or use that proper English.

("Use" itself isn't the grammar problem, it's the comma. You've got two independent clauses joined with a comma splice. "To" makes the first one dependent and fix the grammar error.)

Again, though, I think the above thread's far more important.

Co-authored-by: Aaron Liu <aaronliu0130@gmail.com>

aaronliu0130 · 2026-04-19T20:40:27Z

@cclauss Was closing in error?

cclauss requested review from aaronliu0130 and Copilot April 19, 2026 05:54

coderabbitai bot reviewed Apr 19, 2026

View reviewed changes

Comment thread README.rst Outdated

Comment thread README.rst Outdated

Copilot started reviewing on behalf of cclauss April 19, 2026 05:54 View session

Copilot AI reviewed Apr 19, 2026

View reviewed changes

Comment thread README.rst Outdated

Comment thread README.rst Outdated

Comment thread README.rst Outdated

cclauss force-pushed the add-cclauss-as-maintainer branch from 199cc57 to d270e0e Compare April 19, 2026 06:00

cclauss temporarily deployed to testpypi April 19, 2026 06:00 — with GitHub Actions Inactive

cclauss temporarily deployed to testpypi April 19, 2026 06:02 — with GitHub Actions Inactive

README.rst: Do minor cleanup and add self as a maintainer

dd2490c

cclauss force-pushed the add-cclauss-as-maintainer branch from 3cfee9d to dd2490c Compare April 19, 2026 06:02

cclauss requested a review from Copilot April 19, 2026 06:03

cclauss temporarily deployed to testpypi April 19, 2026 06:03 — with GitHub Actions Inactive

Copilot started reviewing on behalf of cclauss April 19, 2026 06:03 View session

cclauss closed this Apr 19, 2026

cclauss reopened this Apr 19, 2026

Copilot AI reviewed Apr 19, 2026

View reviewed changes

cclauss requested a review from Copilot April 19, 2026 06:05

Copilot started reviewing on behalf of cclauss April 19, 2026 06:06 View session

Copilot AI reviewed Apr 19, 2026

View reviewed changes

aaronliu0130 requested changes Apr 19, 2026

View reviewed changes

cclauss requested a review from aaronliu0130 April 19, 2026 16:53

Update README.rst

3b8e94d

Co-authored-by: Aaron Liu <aaronliu0130@gmail.com>

cclauss deployed to testpypi April 19, 2026 17:56 — with GitHub Actions View deployment

cclauss closed this Apr 19, 2026

Conversation

cclauss commented Apr 19, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

aaronliu0130 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cclauss Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaronliu0130 Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaronliu0130 commented Apr 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cclauss commented Apr 19, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 19, 2026 •

edited

Loading

cclauss Apr 19, 2026 •

edited

Loading

aaronliu0130 Apr 19, 2026 •

edited

Loading