Define @SideEffectsOnly; it has no effect yet and is not documented

[mernst]

No description provided.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: a4cfa633-3230-430a-8d95-b87932b4e120

📥 Commits

Reviewing files that changed from the base of the PR and between ee3de8e and 33ef844.

📒 Files selected for processing (1)

• checker-qual/src/main/java/org/checkerframework/dataflow/qual/SideEffectsOnly.java

---

📝 Walkthrough

Walkthrough

Adds the runtime @SideEffectsOnly annotation in the dataflow qualification package. The annotation applies to methods and constructors and supports inheritance by subtypes. Its value() member accepts Java expressions that describe the upper bound on expressions a method or constructor may modify. The documentation defines constructor behavior, expression requirements, and recursive purity constraints.

Possibly related PRs

• typetools/checker-framework#7733: Updates related @SideEffectFree documentation, including constructor side-effect behavior.
• typetools/checker-framework#7818: Adds the same @SideEffectsOnly annotation and API changes.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}