Rename error key "createsmustcallfor.target.unparseable" to "...unparsable"#7691
Rename error key "createsmustcallfor.target.unparseable" to "...unparsable"#7691mernst merged 3 commits intotypetools:masterfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR contains widespread non-functional edits: spelling/grammar fixes in Javadoc, inline comments, tests, and docs; renames the must-call diagnostic key and helper/reporting identifier from Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/specification/IndexFileSpecification.java (1)
597-603:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix contradictory
@returndescription in Javadoc.Line 602 currently says “synthetic constructor”, but this method is about an implicit default constructor and Line 598 explicitly says it is not synthetic. Please align the
@returntext with the method semantics.Suggested patch
- * `@return` true if the Criteria is on a synthetic constructor + * `@return` true if the Criteria is on an implicit default constructor🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/specification/IndexFileSpecification.java` around lines 597 - 603, Update the Javadoc `@return` to correctly describe the method's semantics: it should state that the method returns true when the given Criteria is on an implicit default constructor (a constructor not defined in source code and not synthetic), not that it is on a "synthetic constructor"; locate the Javadoc for the method in class IndexFileSpecification that mentions Criteria and replace the misleading phrase "synthetic constructor" with "implicit default constructor" or equivalent accurate wording.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/classfile/ClassAnnotationSceneWriter.java`:
- Around line 246-254: Extract the repeated conditional logic that builds a
TypeReference from a BoundLocation into a private helper (e.g.,
createTypeParameterReference) and use it from ensureVisitSceneClassAnnotations
and ensureVisitTypeParameterBoundAnnotations; the helper should accept the two
TypeReference kinds (e.g., TypeReference.CLASS_TYPE_PARAMETER and
TypeReference.CLASS_TYPE_PARAMETER_BOUND) and the BoundLocation (BoundLocation
bLoc) and return the appropriate TypeReference by checking bLoc.boundIndex == -1
and calling either TypeReference.newTypeParameterReference(...) or
TypeReference.newTypeParameterBoundReference(...).
In
`@framework/src/main/java/org/checkerframework/common/value/RangeOrListOfValues.java`:
- Around line 75-78: The Javadoc incorrectly references the class as
"RangeOrListofValues" (lowercase 'o'); update the Javadoc to use the correct
class name "RangeOrListOfValues" wherever referenced (e.g., in the comment above
the method that returns an annotation for this class), ensuring references to
related symbols like ArrayLen, ArrayLenRange and the parameter atypeFactory
remain unchanged and accurate.
In
`@framework/src/main/java/org/checkerframework/framework/stub/StubGenerator.java`:
- Around line 86-87: Replace the hardcoded 4-space literal with the existing
INDENTATION constant in both places where currentIndentation is set (inside
stubFromField and stubFromMethod): change assignments that set
currentIndentation = " " to currentIndentation = INDENTATION so they remain
consistent with the defined constant; ensure both occurrences are updated.
---
Outside diff comments:
In
`@annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/specification/IndexFileSpecification.java`:
- Around line 597-603: Update the Javadoc `@return` to correctly describe the
method's semantics: it should state that the method returns true when the given
Criteria is on an implicit default constructor (a constructor not defined in
source code and not synthetic), not that it is on a "synthetic constructor";
locate the Javadoc for the method in class IndexFileSpecification that mentions
Criteria and replace the misleading phrase "synthetic constructor" with
"implicit default constructor" or equivalent accurate wording.
🪄 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
Run ID: 0f342176-9f72-4ad8-a06b-974465b38117
📒 Files selected for processing (130)
annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/Main.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/AnnotationInsertion.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/InMethodCriterion.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/IsSigMethodCriterion.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/NewInsertion.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/TreeFinder.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/specification/IndexFileSpecification.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/el/AnnotationDef.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/field/BasicAFT.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/IndexFileParser.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/IndexFileWriter.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/classfile/ClassAnnotationSceneWriter.javaannotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/classfile/ClassFileReader.javaannotation-file-utilities/src/test/java/org/checkerframework/afu/scenelib/test/classfile/AnnotationVerifier.javabuild.gradlechecker-qual/src/main/java/org/checkerframework/checker/builder/qual/CalledMethods.javachecker-qual/src/main/java/org/checkerframework/checker/formatter/qual/ConversionCategory.javachecker-qual/src/main/java/org/checkerframework/checker/index/qual/LengthOf.javachecker-qual/src/main/java/org/checkerframework/checker/nonempty/qual/EnsuresNonEmptyIf.javachecker/build.gradlechecker/jtreg/nullness/issue767/Class1.javachecker/jtreg/rawtypes/RawTypeFail.javachecker/jtreg/sortwarnings/ErrorOrders.javachecker/src/main/java/org/checkerframework/checker/formatter/FormatterTreeUtil.javachecker/src/main/java/org/checkerframework/checker/guieffect/GuiEffectTypeFactory.javachecker/src/main/java/org/checkerframework/checker/guieffect/GuiEffectVisitor.javachecker/src/main/java/org/checkerframework/checker/index/lowerbound/LowerBoundTransfer.javachecker/src/main/java/org/checkerframework/checker/index/upperbound/UBQualifier.javachecker/src/main/java/org/checkerframework/checker/initialization/InitializationAnnotatedTypeFactory.javachecker/src/main/java/org/checkerframework/checker/lock/LockAnnotatedTypeFactory.javachecker/src/main/java/org/checkerframework/checker/mustcall/CreatesMustCallForToJavaExpression.javachecker/src/main/java/org/checkerframework/checker/mustcall/messages.propertieschecker/src/main/java/org/checkerframework/checker/nullness/NullnessValue.javachecker/src/main/java/org/checkerframework/checker/nullness/NullnessVisitor.javachecker/src/main/java/org/checkerframework/checker/resourceleak/MustCallConsistencyAnalyzer.javachecker/src/main/java/org/checkerframework/checker/resourceleak/MustCallInference.javachecker/src/main/java/org/checkerframework/checker/rlccalledmethods/RLCCalledMethodsChecker.javachecker/tests/ainfer-index/non-annotated/RequireJavadocCrash.javachecker/tests/ainfer-resourceleak/non-annotated/ReplaceMustCallAliasAnnotation.javachecker/tests/ainfer-testchecker/non-annotated/ExpectedErrors.javachecker/tests/calledmethods-usevaluechecker/SimpleFalsePositive.javachecker/tests/index/CharSequenceTest.javachecker/tests/index/IndexOf.javachecker/tests/interning/ClassDefaults.javachecker/tests/interning/Polymorphism.javachecker/tests/lock/PrimitivesLocking.javachecker/tests/lock/TestTreeKinds.javachecker/tests/mustcall/CreatesMustCallForSimple.javachecker/tests/nullness-records/NormalizingRecord.javachecker/tests/nullness/ArrayCreationNullable.javachecker/tests/nullness/Asserts.javachecker/tests/nullness/Bug102.javachecker/tests/nullness/InvariantTypes.javachecker/tests/nullness/Issue3681.javachecker/tests/nullness/Issue741.javachecker/tests/nullness/Marino.javachecker/tests/nullness/ToArrayNullness.javachecker/tests/nullness/init/Issue409.javachecker/tests/nullness/java8/Issue1046Java8.javachecker/tests/nullness/java8/Issue1633.javachecker/tests/nullness/java8/lambda/LambdaNullness.javachecker/tests/nullness/java8/methodref/AssignmentContextTest.javachecker/tests/nullness/java8/methodref/ReceiversMethodref.javachecker/tests/resourceleak/ACSocketTest.javachecker/tests/resourceleak/CreatesMustCallForIndirect.javachecker/tests/resourceleak/CreatesMustCallForTargets.javachecker/tests/resourceleak/MustCallAliasSocketException.javachecker/tests/resourceleak/OwnershipWithExceptions.javachecker/tests/signedness/MaskedShifts.javachecker/tests/stubparser-nullness/MultidimentionalArrayAnnotationTest.javachecker/tests/tainting/SameTypeBounds.javachecker/tests/units/BasicUnits.javadataflow/manual/checker-framework-dataflow-manual.texdataflow/manual/content.texdataflow/src/main/java/org/checkerframework/dataflow/cfg/builder/CFGTranslationPhaseOne.javadataflow/src/main/java/org/checkerframework/dataflow/cfg/builder/CFGTranslationPhaseThree.javadataflow/src/main/java/org/checkerframework/dataflow/cfg/node/ArrayAccessNode.javadataflow/src/main/java/org/checkerframework/dataflow/util/PurityChecker.javadocs/CHANGELOG.mddocs/examples/units-extension/UnitsExtensionDemo.javadocs/manual/annotating-libraries.texdocs/manual/external-checkers.texdocs/manual/formatter-checker.texdocs/manual/nullness-checker.texdocs/manual/optional-checker.texframework-test/src/main/java/org/checkerframework/framework/test/TestUtilities.javaframework/src/main/java/org/checkerframework/common/basetype/BaseTypeValidator.javaframework/src/main/java/org/checkerframework/common/basetype/BaseTypeVisitor.javaframework/src/main/java/org/checkerframework/common/util/count/AnnotationStatistics.javaframework/src/main/java/org/checkerframework/common/util/debug/SignaturePrinter.javaframework/src/main/java/org/checkerframework/common/value/RangeOrListOfValues.javaframework/src/main/java/org/checkerframework/common/value/ValueAnnotatedTypeFactory.javaframework/src/main/java/org/checkerframework/common/value/ValueMethodIdentifier.javaframework/src/main/java/org/checkerframework/common/value/util/Range.javaframework/src/main/java/org/checkerframework/common/wholeprograminference/SceneToStubWriter.javaframework/src/main/java/org/checkerframework/common/wholeprograminference/WholeProgramInferenceJavaParserStorage.javaframework/src/main/java/org/checkerframework/common/wholeprograminference/WholeProgramInferenceScenesStorage.javaframework/src/main/java/org/checkerframework/framework/ajava/JointJavacJavaParserVisitor.javaframework/src/main/java/org/checkerframework/framework/flow/CFAbstractTransfer.javaframework/src/main/java/org/checkerframework/framework/source/SourceChecker.javaframework/src/main/java/org/checkerframework/framework/stub/AnnotationFileParser.javaframework/src/main/java/org/checkerframework/framework/stub/StubGenerator.javaframework/src/main/java/org/checkerframework/framework/type/AnnotatedTypeFactory.javaframework/src/main/java/org/checkerframework/framework/type/QualifierHierarchy.javaframework/src/main/java/org/checkerframework/framework/type/TypeFromExpressionVisitor.javaframework/src/main/java/org/checkerframework/framework/util/typeinference8/InvocationTypeInference.javaframework/src/main/java/org/checkerframework/framework/util/typeinference8/bound/BoundSet.javaframework/src/main/java/org/checkerframework/framework/util/typeinference8/types/AbstractType.javaframework/src/main/java/org/checkerframework/framework/util/typeinference8/types/UseOfVariable.javaframework/src/main/java/org/checkerframework/framework/util/typeinference8/util/Resolution.javaframework/tests/aggregate/JavaErrorTest.javaframework/tests/all-systems/Issue2370.javaframework/tests/all-systems/Issue4849.javaframework/tests/all-systems/Issue4879.javaframework/tests/all-systems/java21/JEP440.javaframework/tests/all-systems/java21/JEP441.javaframework/tests/all-systems/java8/memberref/AssignmentContextFunction.javaframework/tests/all-systems/java8inference/CollectorsToList.javaframework/tests/classval/GLBTest.javaframework/tests/compound-checker/javac-error/JavaErrorTest.javaframework/tests/framework/AnnotatedGenerics.javaframework/tests/framework/RandomTests.javaframework/tests/javaexpression/Unparsable.javaframework/tests/subtyping/ThrowCatch.javaframework/tests/value/ArrayInit.javajavacutil/src/main/java/org/checkerframework/javacutil/AnnotationMirrorMap.javajavacutil/src/main/java/org/checkerframework/javacutil/AnnotationUtils.javajavacutil/src/main/java/org/checkerframework/javacutil/ElementUtils.javajavacutil/src/main/java/org/checkerframework/javacutil/TypeAnnotationUtils.javajavacutil/src/main/java/org/checkerframework/javacutil/TypesUtils.java
No description provided.