Skip to content
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.

Sign up for GitHub

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

Fix docs spelling #152

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix docs spelling #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
323fbcf
Update AssetVault.sol
nnsW3 Jan 10, 2025
f3080ca
Update SignedOperations.sol
nnsW3 Jan 10, 2025
d2c65e6
Update YieldToken.sol
nnsW3 Jan 10, 2025
3b713d2
Update Empty.sol
nnsW3 Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion smart-wallets/src/Empty.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pragma solidity 0.8.25;
* @author Eugene Y. Q. Shen
* @notice Empty contract that has nothing in it and does nothing
* @dev This empty contract is used as the initial implementation contract
* when deploying new proxy contracts to ensure that the addresses all
* when deploying new proxy contracts ensure that the addresses all
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is grammatically incorrect

* stay the same when using CREATE2 to deploy them on different chains.
*/
contract Empty {
Expand Down
6 changes: 3 additions & 3 deletions smart-wallets/src/extensions/AssetVault.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ contract AssetVault is WalletUtils, IAssetVault {
/**
* @notice Redistribute yield to the beneficiaries of the AssetToken, using yield distributions
* @dev Only the user wallet can initiate the yield redistribution. The yield redistributed
* to each beneficiary is rounded down, and any remaining CurrencyToken are kept in the vault.
* to each beneficiary is rounded down, and any remaining CurrencyToken is kept in the vault.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is grammatically incorrect

* The Solidity compiler adds a check that the target address has `extcodesize > 0`
* and otherwise reverts for high-level calls, so we have to use a low-level call here
* @param assetToken AssetToken from which the yield is to be redistributed
Expand Down Expand Up @@ -348,7 +348,7 @@ contract AssetVault is WalletUtils, IAssetVault {
return;
}

// Look for existing distribution with same beneficiary and expiration
// Look for existing distribution with the same beneficiary and expiration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unnecessary in a short comment

while (true) {
if (distribution.beneficiary == beneficiary && distribution.yield.expiration == expiration) {
distribution.yield.amount += amount;
Expand Down Expand Up @@ -378,7 +378,7 @@ contract AssetVault is WalletUtils, IAssetVault {
* If there are too many yield distributions to process, the function will stop to avoid
* reaching the gas limit, and the beneficiary must call the function again to renounce more.
* @param assetToken AssetToken from which the yield is to be redistributed
* @param amount Amount of AssetTokens to renounce from from the yield distribution
* @param amount Amount of AssetTokens to renounce from the yield distribution
* @param expiration Timestamp at which the yield expires
*/
function renounceYieldDistribution(
Expand Down
2 changes: 1 addition & 1 deletion smart-wallets/src/extensions/SignedOperations.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ contract SignedOperations is EIP712, WalletUtils, ISignedOperations {

/**
* @notice Cancel pending SignedOperations that have not yet been executed
* @dev This function can only be called by the user that signed the SignedOperations.
* @dev This function can only be called by the user who signed the SignedOperations.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user may not be a person (e.g. automated system), so "that" is appropriate

* After this, the affected SignedOperations will revert when trying to be executed.
* @param nonce Nonce of the SignedOperations to cancel
*/
Expand Down
2 changes: 1 addition & 1 deletion smart-wallets/src/token/YieldToken.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ contract YieldToken is YieldDistributionToken, ERC4626, WalletUtils, IYieldToken
* @notice Emitted when the vault has been notified of the completion of a redeem request
* @param controller Controller of the request
* @param assets Amount of `asset` to receive in exchange
* @param shares Amount of shares that has been redeemed
* @param shares Amount of shares that have been redeemed
*/
event RedeemNotified(address indexed controller, uint256 assets, uint256 shares);

Expand Down