Skip to content

Rename error key "createsmustcallfor.target.unparseable" to "...unparsable"#7691

Merged
mernst merged 3 commits intotypetools:masterfrom
mernst:spelling
May 3, 2026
Merged

Rename error key "createsmustcallfor.target.unparseable" to "...unparsable"#7691
mernst merged 3 commits intotypetools:masterfrom
mernst:spelling

Conversation

@mernst
Copy link
Copy Markdown
Member

@mernst mernst commented May 3, 2026

No description provided.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c25cdc9f-3040-49d5-827f-e3b35317c919

📥 Commits

Reviewing files that changed from the base of the PR and between 5369221 and b80a809.

📒 Files selected for processing (1)
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/IndexFileParser.java

📝 Walkthrough

Walkthrough

This 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 createsmustcallfor.target.unparseablecreatesmustcallfor.target.unparsable; renames indentation identifiers INDENTION/currentIndentionINDENTATION/currentIndentation; renames a test method propogateToExpr()propagateToExpr(); and a few small identifier/comment adjustments (e.g., doutdOut). No algorithmic or runtime behavior changes were introduced.

Possibly related PRs

Suggested reviewers

  • smillst
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 56.86% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
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

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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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 win

Fix contradictory @return description 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 @return text 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

📥 Commits

Reviewing files that changed from the base of the PR and between 80402f1 and 0636098.

📒 Files selected for processing (130)
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/Main.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/AnnotationInsertion.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/InMethodCriterion.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/IsSigMethodCriterion.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/NewInsertion.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/find/TreeFinder.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/annotator/specification/IndexFileSpecification.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/el/AnnotationDef.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/field/BasicAFT.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/IndexFileParser.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/IndexFileWriter.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/classfile/ClassAnnotationSceneWriter.java
  • annotation-file-utilities/src/main/java/org/checkerframework/afu/scenelib/io/classfile/ClassFileReader.java
  • annotation-file-utilities/src/test/java/org/checkerframework/afu/scenelib/test/classfile/AnnotationVerifier.java
  • build.gradle
  • checker-qual/src/main/java/org/checkerframework/checker/builder/qual/CalledMethods.java
  • checker-qual/src/main/java/org/checkerframework/checker/formatter/qual/ConversionCategory.java
  • checker-qual/src/main/java/org/checkerframework/checker/index/qual/LengthOf.java
  • checker-qual/src/main/java/org/checkerframework/checker/nonempty/qual/EnsuresNonEmptyIf.java
  • checker/build.gradle
  • checker/jtreg/nullness/issue767/Class1.java
  • checker/jtreg/rawtypes/RawTypeFail.java
  • checker/jtreg/sortwarnings/ErrorOrders.java
  • checker/src/main/java/org/checkerframework/checker/formatter/FormatterTreeUtil.java
  • checker/src/main/java/org/checkerframework/checker/guieffect/GuiEffectTypeFactory.java
  • checker/src/main/java/org/checkerframework/checker/guieffect/GuiEffectVisitor.java
  • checker/src/main/java/org/checkerframework/checker/index/lowerbound/LowerBoundTransfer.java
  • checker/src/main/java/org/checkerframework/checker/index/upperbound/UBQualifier.java
  • checker/src/main/java/org/checkerframework/checker/initialization/InitializationAnnotatedTypeFactory.java
  • checker/src/main/java/org/checkerframework/checker/lock/LockAnnotatedTypeFactory.java
  • checker/src/main/java/org/checkerframework/checker/mustcall/CreatesMustCallForToJavaExpression.java
  • checker/src/main/java/org/checkerframework/checker/mustcall/messages.properties
  • checker/src/main/java/org/checkerframework/checker/nullness/NullnessValue.java
  • checker/src/main/java/org/checkerframework/checker/nullness/NullnessVisitor.java
  • checker/src/main/java/org/checkerframework/checker/resourceleak/MustCallConsistencyAnalyzer.java
  • checker/src/main/java/org/checkerframework/checker/resourceleak/MustCallInference.java
  • checker/src/main/java/org/checkerframework/checker/rlccalledmethods/RLCCalledMethodsChecker.java
  • checker/tests/ainfer-index/non-annotated/RequireJavadocCrash.java
  • checker/tests/ainfer-resourceleak/non-annotated/ReplaceMustCallAliasAnnotation.java
  • checker/tests/ainfer-testchecker/non-annotated/ExpectedErrors.java
  • checker/tests/calledmethods-usevaluechecker/SimpleFalsePositive.java
  • checker/tests/index/CharSequenceTest.java
  • checker/tests/index/IndexOf.java
  • checker/tests/interning/ClassDefaults.java
  • checker/tests/interning/Polymorphism.java
  • checker/tests/lock/PrimitivesLocking.java
  • checker/tests/lock/TestTreeKinds.java
  • checker/tests/mustcall/CreatesMustCallForSimple.java
  • checker/tests/nullness-records/NormalizingRecord.java
  • checker/tests/nullness/ArrayCreationNullable.java
  • checker/tests/nullness/Asserts.java
  • checker/tests/nullness/Bug102.java
  • checker/tests/nullness/InvariantTypes.java
  • checker/tests/nullness/Issue3681.java
  • checker/tests/nullness/Issue741.java
  • checker/tests/nullness/Marino.java
  • checker/tests/nullness/ToArrayNullness.java
  • checker/tests/nullness/init/Issue409.java
  • checker/tests/nullness/java8/Issue1046Java8.java
  • checker/tests/nullness/java8/Issue1633.java
  • checker/tests/nullness/java8/lambda/LambdaNullness.java
  • checker/tests/nullness/java8/methodref/AssignmentContextTest.java
  • checker/tests/nullness/java8/methodref/ReceiversMethodref.java
  • checker/tests/resourceleak/ACSocketTest.java
  • checker/tests/resourceleak/CreatesMustCallForIndirect.java
  • checker/tests/resourceleak/CreatesMustCallForTargets.java
  • checker/tests/resourceleak/MustCallAliasSocketException.java
  • checker/tests/resourceleak/OwnershipWithExceptions.java
  • checker/tests/signedness/MaskedShifts.java
  • checker/tests/stubparser-nullness/MultidimentionalArrayAnnotationTest.java
  • checker/tests/tainting/SameTypeBounds.java
  • checker/tests/units/BasicUnits.java
  • dataflow/manual/checker-framework-dataflow-manual.tex
  • dataflow/manual/content.tex
  • dataflow/src/main/java/org/checkerframework/dataflow/cfg/builder/CFGTranslationPhaseOne.java
  • dataflow/src/main/java/org/checkerframework/dataflow/cfg/builder/CFGTranslationPhaseThree.java
  • dataflow/src/main/java/org/checkerframework/dataflow/cfg/node/ArrayAccessNode.java
  • dataflow/src/main/java/org/checkerframework/dataflow/util/PurityChecker.java
  • docs/CHANGELOG.md
  • docs/examples/units-extension/UnitsExtensionDemo.java
  • docs/manual/annotating-libraries.tex
  • docs/manual/external-checkers.tex
  • docs/manual/formatter-checker.tex
  • docs/manual/nullness-checker.tex
  • docs/manual/optional-checker.tex
  • framework-test/src/main/java/org/checkerframework/framework/test/TestUtilities.java
  • framework/src/main/java/org/checkerframework/common/basetype/BaseTypeValidator.java
  • framework/src/main/java/org/checkerframework/common/basetype/BaseTypeVisitor.java
  • framework/src/main/java/org/checkerframework/common/util/count/AnnotationStatistics.java
  • framework/src/main/java/org/checkerframework/common/util/debug/SignaturePrinter.java
  • framework/src/main/java/org/checkerframework/common/value/RangeOrListOfValues.java
  • framework/src/main/java/org/checkerframework/common/value/ValueAnnotatedTypeFactory.java
  • framework/src/main/java/org/checkerframework/common/value/ValueMethodIdentifier.java
  • framework/src/main/java/org/checkerframework/common/value/util/Range.java
  • framework/src/main/java/org/checkerframework/common/wholeprograminference/SceneToStubWriter.java
  • framework/src/main/java/org/checkerframework/common/wholeprograminference/WholeProgramInferenceJavaParserStorage.java
  • framework/src/main/java/org/checkerframework/common/wholeprograminference/WholeProgramInferenceScenesStorage.java
  • framework/src/main/java/org/checkerframework/framework/ajava/JointJavacJavaParserVisitor.java
  • framework/src/main/java/org/checkerframework/framework/flow/CFAbstractTransfer.java
  • framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java
  • framework/src/main/java/org/checkerframework/framework/stub/AnnotationFileParser.java
  • framework/src/main/java/org/checkerframework/framework/stub/StubGenerator.java
  • framework/src/main/java/org/checkerframework/framework/type/AnnotatedTypeFactory.java
  • framework/src/main/java/org/checkerframework/framework/type/QualifierHierarchy.java
  • framework/src/main/java/org/checkerframework/framework/type/TypeFromExpressionVisitor.java
  • framework/src/main/java/org/checkerframework/framework/util/typeinference8/InvocationTypeInference.java
  • framework/src/main/java/org/checkerframework/framework/util/typeinference8/bound/BoundSet.java
  • framework/src/main/java/org/checkerframework/framework/util/typeinference8/types/AbstractType.java
  • framework/src/main/java/org/checkerframework/framework/util/typeinference8/types/UseOfVariable.java
  • framework/src/main/java/org/checkerframework/framework/util/typeinference8/util/Resolution.java
  • framework/tests/aggregate/JavaErrorTest.java
  • framework/tests/all-systems/Issue2370.java
  • framework/tests/all-systems/Issue4849.java
  • framework/tests/all-systems/Issue4879.java
  • framework/tests/all-systems/java21/JEP440.java
  • framework/tests/all-systems/java21/JEP441.java
  • framework/tests/all-systems/java8/memberref/AssignmentContextFunction.java
  • framework/tests/all-systems/java8inference/CollectorsToList.java
  • framework/tests/classval/GLBTest.java
  • framework/tests/compound-checker/javac-error/JavaErrorTest.java
  • framework/tests/framework/AnnotatedGenerics.java
  • framework/tests/framework/RandomTests.java
  • framework/tests/javaexpression/Unparsable.java
  • framework/tests/subtyping/ThrowCatch.java
  • framework/tests/value/ArrayInit.java
  • javacutil/src/main/java/org/checkerframework/javacutil/AnnotationMirrorMap.java
  • javacutil/src/main/java/org/checkerframework/javacutil/AnnotationUtils.java
  • javacutil/src/main/java/org/checkerframework/javacutil/ElementUtils.java
  • javacutil/src/main/java/org/checkerframework/javacutil/TypeAnnotationUtils.java
  • javacutil/src/main/java/org/checkerframework/javacutil/TypesUtils.java

@mernst mernst merged commit 417afa2 into typetools:master May 3, 2026
37 checks passed
@mernst mernst deleted the spelling branch May 3, 2026 16:36
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.

1 participant