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.

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

wants to merge 4 commits into from

Conversation

nnsW3
Copy link

@nnsW3 nnsW3 commented Jan 10, 2025

Hello
While looking through your docs I found and fixed several spelling issues.
Br, Elias.

@eyqs
Copy link
Member

eyqs commented Jan 10, 2025

Thank you for your contribution @nnsW3!

@@ -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

@@ -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

@@ -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

@@ -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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants