Skip to content

Commit 28724ea

Browse files
authored
Merge pull request #609 from nnsW3/docs-fix-spelling-issues
docs fix spelling issues
2 parents 5a802d7 + 3c18324 commit 28724ea

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ contract Storage {
165165

166166
### stdCheats
167167

168-
This is a wrapper over miscellaneous cheatcodes that need wrappers to be more dev friendly. Currently there are only functions related to `prank`. In general, users may expect ETH to be put into an address on `prank`, but this is not the case for safety reasons. Explicitly this `hoax` function should only be used for address that have expected balances as it will get overwritten. If an address already has ETH, you should just use `prank`. If you want to change that balance explicitly, just use `deal`. If you want to do both, `hoax` is also right for you.
168+
This is a wrapper over miscellaneous cheatcodes that need wrappers to be more dev friendly. Currently there are only functions related to `prank`. In general, users may expect ETH to be put into an address on `prank`, but this is not the case for safety reasons. Explicitly this `hoax` function should only be used for addresses that have expected balances as it will get overwritten. If an address already has ETH, you should just use `prank`. If you want to change that balance explicitly, just use `deal`. If you want to do both, `hoax` is also right for you.
169169

170170

171171
#### Example usage:

src/StdCheats.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ abstract contract StdCheatsSafe {
228228

229229
// Checks that `addr` is not blacklisted by token contracts that have a blacklist.
230230
// This is identical to `assumeNotBlacklisted(address,address)` but with a different name, for
231-
// backwards compatibility, since this name was used in the original PR which has already has
231+
// backwards compatibility, since this name was used in the original PR which already has
232232
// a release. This function can be removed in a future release once we want a breaking change.
233233
function assumeNoBlacklisted(address token, address addr) internal view virtual {
234234
assumeNotBlacklisted(token, addr);

src/interfaces/IERC4626.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ interface IERC4626 is IERC20 {
119119
function mint(uint256 shares, address receiver) external returns (uint256 assets);
120120

121121
/// @notice Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the
122-
/// Vault, through a withdraw call.
122+
/// Vault, through a withdrawal call.
123123
/// @dev
124124
/// - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
125125
/// - MUST NOT revert.
@@ -145,7 +145,7 @@ interface IERC4626 is IERC20 {
145145
/// @dev
146146
/// - MUST emit the Withdraw event.
147147
/// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
148-
/// withdraw execution, and are accounted for during withdraw.
148+
/// withdraw execution, and are accounted for during withdrawal.
149149
/// - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
150150
/// not having enough shares, etc).
151151
///

0 commit comments

Comments
 (0)