-
Notifications
You must be signed in to change notification settings - Fork 12.3k
Typos and other minor fixes (group n°5) #5959
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
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.
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/_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 <[email protected]>
Co-authored-by: Hadrien Croubois <[email protected]>
Signed-off-by: Nikita Khateev <[email protected]> Signed-off-by: dulanting <[email protected]> Co-authored-by: Nikita Khateev <[email protected]> Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: ernestognw <[email protected]>
Co-authored-by: ernestognw <[email protected]>
Co-authored-by: Ernesto García <[email protected]>
…6027) Co-authored-by: Ernesto García <[email protected]>
…6037) Co-authored-by: Ernesto García <[email protected]>
Co-authored-by: Hadrien Croubois <[email protected]>
…zation (#6046) Co-authored-by: Ernesto García <[email protected]>
Co-authored-by: Ernesto García <[email protected]>
Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: ernestognw <[email protected]>
No description provided.