fix: clarify ERC20FlashMint maxFlashLoan note

[reallesee]

Update the maxFlashLoan note so it references the actual default return value and aligns the documentation with current behavior.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 0431a8daa4138fa07158770e86f35cb9f53a70eb

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[bot]]

Walkthrough

The change updates documentation in the ERC20FlashMint contract. Specifically, a comment in the maxFlashLoan method is revised to clarify the default cap calculation. The updated note specifies that the default cap is calculated as type(uint256).max - totalSupply(). This is a documentation-only change with no modifications to code logic or contract behavior.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: clarifying documentation in the ERC20FlashMint maxFlashLoan note.
Description check	✅ Passed	The description is directly related to the changeset, explaining that the maxFlashLoan note was updated to reference the actual default return value and align documentation with current behavior.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6308fdc5e8e0d5e8a94dc9d5d4c79f6331334c81 and f5cfaf07b5d927174e0d514ee8f6fb6871a99d09.

📒 Files selected for processing (1)

• contracts/token/ERC20/extensions/ERC20FlashMint.sol (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

• GitHub Check: Redirect rules - solidity-contracts
• GitHub Check: tests
• GitHub Check: Header rules - solidity-contracts
• GitHub Check: tests-foundry
• GitHub Check: coverage
• GitHub Check: tests-upgradeable
• GitHub Check: slither
• GitHub Check: halmos
• GitHub Check: Pages changed - solidity-contracts

🔇 Additional comments (1)

contracts/token/ERC20/extensions/ERC20FlashMint.sol (1)

44-46: Documentation now accurately reflects the default behavior.

The updated note clarifies that the default cap calculation is type(uint256).max - totalSupply(), which matches the actual implementation on line 49. This improves clarity for developers integrating this extension, especially when deciding whether they need to override maxFlashLoan for supply-capped tokens.

---

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