Skip to content

Change recommended library name#19

Merged
smillst merged 1 commit into
mainfrom
checker-framework-library
Mar 23, 2026
Merged

Change recommended library name#19
smillst merged 1 commit into
mainfrom
checker-framework-library

Conversation

@mernst

@mernst mernst commented Mar 7, 2026

Copy link
Copy Markdown
Member

No description provided.

@mernst mernst requested a review from smillst March 7, 2026 17:01
@coderabbitai

coderabbitai Bot commented Mar 7, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

The README.md file has been updated with documentation changes. The wording for Checker Framework configuration guidance has been revised from "The recommended way" to "The Gradle developers recommend". The Gradle configuration example now references the correct property path for accessing the Checker Framework version, and the library key in the gradle libs versions TOML example has been renamed to reflect the proper naming convention. These updates affect only documentation and configuration examples without modifying any functional code.

🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch checker-framework-library

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 the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 32: Replace the non-idiomatic phrase "recommend to modify" in the README
sentence ("The Gradle developers recommend to modify two files. Add this to
`build.gradle`:") with a correct construction such as "recommend modifying" or
"recommend that you modify" so the sentence reads either "The Gradle developers
recommend modifying two files." or "The Gradle developers recommend that you
modify two files." and keep the rest of the sentence ("Add this to
`build.gradle`:") unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 21f637c2-06fa-4b5a-b861-9979b724cc96

📥 Commits

Reviewing files that changed from the base of the PR and between 6815333 and e031f1e.

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

Comment thread README.md
@smillst smillst merged commit 7a3a33d into main Mar 23, 2026
57 checks passed
@smillst smillst deleted the checker-framework-library branch March 23, 2026 18:13
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