Documentation - #7906
Merged
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughUpdated documentation comments across annotation utilities, checker visitors, command-line help, and the manual. Added Javadoc for private array conversion helpers. Clarified constructor-result annotation requirements, constructor receiver notes, enum constructor wording, suppression-reason option behavior, and Oracle Javadoc reference escaping rules. No executable behavior or public declarations changed. Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.github.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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
`@annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/el/AClass.java`:
- Around line 24-25: Update the Javadoc for the AClass.extendsImplements field
to describe non-negative TypeIndexLocation values as identifying implemented or
extended interfaces, while retaining the existing -1 superclass mapping.
In `@checker/bin-devel/count-suppression-reasons`:
- Line 12: Update the -y option description in count-suppression-reasons to
identify it as the second exclusion filter, and clarify that -x and -y together
provide two exclusion patterns while -y itself accepts one grep -v pattern.
In
`@checker/src/main/java/org/checkerframework/checker/initialization/InitializationVisitor.java`:
- Line 90: Reword the TODO in InitializationVisitor to refer specifically to
non-static inner classes rather than nested classes, making clear that their
constructors can have receiver parameters and avoiding inclusion of static
nested classes.
In `@docs/manual/manual-style.tex`:
- Around line 174-176: Update the documentation comments for the Javadoc macros
so the \url restriction applies specifically to the second argument of
\sunjavadoc and \sunjavadocanno, rather than to the body of any macro; preserve
the existing guidance for the other arguments.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: db0e9544-4eac-4c4a-a860-91865dfc2204
📒 Files selected for processing (8)
annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/el/AClass.javachecker-qual/src/main/java/org/checkerframework/checker/formatter/qual/ConversionCategory.javachecker-qual/src/main/java/org/checkerframework/checker/i18nformatter/qual/I18nConversionCategory.javachecker/bin-devel/count-suppression-reasonschecker/src/main/java/org/checkerframework/checker/initialization/InitializationVisitor.javachecker/src/main/java/org/checkerframework/checker/interning/InterningVisitor.javadocs/manual/manual-style.texjavacutil/src/main/java/org/checkerframework/javacutil/AnnotationUtils.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.