Tweak documentation of @SideEffectFree

[mernst]

Merge after #7739.

[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

Run ID: 4191e14d-272e-42bf-9884-ebb1c4484a83

📥 Commits

Reviewing files that changed from the base of the PR and between 110b0c0 and 5136c3d.

📒 Files selected for processing (6)

• .azure/azure-pipelines.yml
• .azure/defs.m4
• .circleci/config.yml
• .circleci/defs.m4
• .github/workflows/ci.yml
• .github/workflows/defs.m4

---

📝 Walkthrough

Walkthrough

This PR updates the Javadoc documentation for the @SideEffectFree annotation to clarify constructor semantics. The revised description explicitly states that a constructor is side-effect-free if it does not modify any objects that existed before the constructor call in ways that are externally visible. No functional code or behavior changed—this is a pure documentation wording refinement.

Possibly related PRs

• typetools/checker-framework#7738: Both PRs modify the same CI “misc” jobs (azure/circle/.github workflows and related defs) around the plume “git debug” helpers—Diagnostics for git-scripts scripts #7738 adds git-change-info/ci-info diagnostic steps, while the main PR later replaces that git-change-info/ci-info pair with a git-changes --debug step.

Suggested reviewers

• smillst

🚥 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.

_{✏️ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 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
`@checker-qual/src/main/java/org/checkerframework/dataflow/qual/SideEffectFree.java`:
- Around line 15-16: The JavaDoc sentence in the SideEffectFree annotation
comment contains an incorrect comma after "objects"; edit the comment in
org.checkerframework.dataflow.qual.SideEffectFree (the class/file containing the
JavaDoc) to remove that comma so the restrictive relative clause "that existed
before it was called" is not set off by punctuation, i.e., change "objects, that
existed before it was called" to "objects that existed before it was called" and
ensure spacing and punctuation around the sentence remain correct.

🪄 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: a8d4229f-a736-4975-b7f0-15aa4a197a41

📥 Commits

Reviewing files that changed from the base of the PR and between 2de71a5 and 3ca8f23.

📒 Files selected for processing (1)

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

[coderabbitai]

Actionable comments posted: 1

🤖 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 `@docs/manual/creating-a-checker.tex`:
- Around line 2173-2174: The sentence in docs/manual/creating-a-checker.tex
still references "Travis CI" as an example even though Travis CI was removed
from supported CI in docs/developer/developer-manual.html; update that sentence
to remove the Travis-specific example and use a generic phrase (e.g. "a CI
service" or "continuous integration systems") or substitute a
currently-supported CI provider name instead, ensuring the change is applied to
the exact text "for example, Travis CI terminates any job that does not produce
output for 10 minutes" so it reads consistently with the developer manual.

🪄 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: ec9ea5d3-4279-4a37-9896-ec9eb3ce04dd

📥 Commits

Reviewing files that changed from the base of the PR and between 8606f2a and 110b0c0.

📒 Files selected for processing (4)

• .travis-build.sh
• .travis.yml
• docs/developer/developer-manual.html
• docs/manual/creating-a-checker.tex

💤 Files with no reviewable changes (2)

• .travis-build.sh
• .travis.yml