Document that ReentrancyGuardTransient and ReentrancyGuard are not interoperable

[arr00]

Document that ReentrancyGuard and ReentrancyGuardTransient are not interoperable.

PR Checklist

• Tests
• Documentation
• Changeset entry (run npx changeset add)

[changeset-bot]

⚠️ No Changeset found

Latest commit: a42aa37

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This pull request adds clarifying documentation to two reentrancy guard contracts. A NOTE is added to ReentrancyGuard.sol and NatSpec documentation is updated in ReentrancyGuardTransient.sol to explicitly state that the two guards are not interoperable. Each guard maintains its own independent reentrancy state, meaning a nonReentrant call protected by one guard does not prevent reentrant calls protected by the other.

Possibly related PRs

• ReentrancyGuard & ReentrancyGuardTransient are stateless #5944: Makes documentation-only changes to ReentrancyGuard and ReentrancyGuardTransient addressing their non-interoperable behavior

Suggested labels

ignore-changeset

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: documenting that ReentrancyGuardTransient and ReentrancyGuard are not interoperable, which aligns directly with the additions to both guard files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check	✅ Passed	The pull request description directly describes the changeset: documenting that ReentrancyGuard and ReentrancyGuardTransient are not interoperable, which aligns with the actual code changes made to both files.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[Amxx]

I'm not sure we need to worry about documenting this.

Both version implement the nonReentrant modifier, which is non-virtual. That means it is not possible to inherit from both version at the same time. The compiler will be very clear.

@ernestognw WDYT ?

[arr00]

I'm not sure we need to worry about documenting this.

Both version implement the nonReentrant modifier, which is non-virtual. That means it is not possible to inherit from both version at the same time. The compiler will be very clear.

@ernestognw WDYT ?

The concern is related to diamond proxies where different facets inherit a different version of reentrancy.