Skip to content

Conversation

@Amxx
Copy link
Collaborator

@Amxx Amxx commented Sep 29, 2025

No description provided.

@changeset-bot
Copy link

changeset-bot bot commented Sep 29, 2025

⚠️ No Changeset found

Latest commit: a8de514

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
Copy link
Contributor

coderabbitai bot commented Sep 29, 2025

Walkthrough

This change updates a documentation comment in contracts/mocks/docs/ERC4626Fees.sol. Specifically, the docstring for the _withdraw function now references IERC4626-_withdraw instead of IERC4626-_deposit. There are no code, logic, or interface modifications; only the comment text was corrected.

Possibly related PRs

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description Check ❓ Inconclusive No description was provided for this pull request, so it’s impossible to confirm the intent or context of the documented reference update, leaving reviewers without guidance on the significance of the change. Please add a brief description outlining that this pull request fixes a typo in the _withdraw function’s doc comment by referencing IERC4626-_withdraw rather than IERC4626-_deposit in ERC4626Fees.sol.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title check ✅ Passed The title accurately describes the pull request as a collection of typo and minor fixes, which aligns with the actual change (documentation reference correction in ERC4626Fees.sol).
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch typo-fixes

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

Copy link
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: 0

🧹 Nitpick comments (1)
contracts/mocks/docs/ERC4626Fees.sol (1)

48-49: Optional: point cross-refs to ERC4626 (not IERC4626) for underscored hooks.

_deposit/_withdraw are internal hooks on ERC4626, not part of IERC4626. Consider adjusting the doc links so they resolve to the actual symbols.

Proposed doc-only diff:

-    /// @dev Send entry fee to {_entryFeeRecipient}. See {IERC4626-_deposit}.
+    /// @dev Send entry fee to {_entryFeeRecipient}. See {ERC4626-_deposit}.
@@
-    /// @dev Send exit fee to {_exitFeeRecipient}. See {IERC4626-_withdraw}.
+    /// @dev Send exit fee to {_exitFeeRecipient}. See {ERC4626-_withdraw}.

Please confirm these anchors resolve in the generated docs.

Also applies to: 60-61

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5eb047a and a1aa81b.

📒 Files selected for processing (1)
  • contracts/mocks/docs/ERC4626Fees.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). (6)
  • GitHub Check: coverage
  • GitHub Check: slither
  • GitHub Check: tests-foundry
  • GitHub Check: tests-upgradeable
  • GitHub Check: tests
  • GitHub Check: halmos
🔇 Additional comments (1)
contracts/mocks/docs/ERC4626Fees.sol (1)

60-61: Typo fix is correct.

Updating the comment to reference _withdraw (not _deposit) is accurate for this function.

arr00
arr00 previously approved these changes Sep 29, 2025
@Amxx Amxx marked this pull request as draft October 6, 2025 08:11
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw ernestognw marked this pull request as ready for review November 5, 2025 20:27
@ernestognw ernestognw marked this pull request as draft November 5, 2025 20:27
@Amxx Amxx changed the title Group typo fixes n°5 Typos and other minor fixes (group n°5) Nov 10, 2025
@Amxx Amxx added this to the 5.6 milestone Nov 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.