Conversation
|
WalkthroughThis 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)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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/_withdraware 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
📒 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.
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Signed-off-by: Nikita Khateev <nikita.khateev@openzeppelin.com> Signed-off-by: dulanting <dulanting@outlook.jp> Co-authored-by: Nikita Khateev <nikita.khateev@gmail.com> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: ernestognw <ernestognw@gmail.com>
Co-authored-by: ernestognw <ernestognw@gmail.com>
Co-authored-by: Ernesto García <ernestognw@gmail.com>
…6027) Co-authored-by: Ernesto García <ernestognw@gmail.com>
Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com>
No description provided.