Browse Source

docs(contracts): fix typos and grammar in NatSpec comments (#5873)

Co-authored-by: Ernesto García <ernestognw@gmail.com>
radik878 1 month ago
parent
commit
e0486a9180

+ 1 - 1
contracts/access/extensions/IAccessControlDefaultAdminRules.sol

@@ -182,7 +182,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      * When the {defaultAdminDelay} is scheduled to be increased, it goes into effect after the new delay has passed with
      * the purpose of giving enough time for reverting any accidental change (i.e. using milliseconds instead of seconds)
      * that may lock the contract. However, to avoid excessive schedules, the wait is capped by this function and it can
-     * be overrode for a custom {defaultAdminDelay} increase scheduling.
+     * be overridden for a custom {defaultAdminDelay} increase scheduling.
      *
      * IMPORTANT: Make sure to add a reasonable amount of time while overriding this value, otherwise,
      * there's a risk of setting a high new delay that goes into effect almost immediately without the

+ 1 - 1
contracts/finance/VestingWallet.sol

@@ -106,7 +106,7 @@ contract VestingWallet is Context, Ownable {
     }
 
     /**
-     * @dev Release the native token (ether) that have already vested.
+     * @dev Release the native token (ether) that has already vested.
      *
      * Emits a {EtherReleased} event.
      */

+ 1 - 1
contracts/governance/Governor.sol

@@ -659,7 +659,7 @@ abstract contract Governor is Context, ERC165, EIP712, Nonces, IGovernor, IERC72
     }
 
     /**
-     * @dev Address through which the governor executes action. Will be overloaded by module that execute actions
+     * @dev Address through which the governor executes action. Will be overloaded by module that executes actions
      * through another contract such as a timelock.
      */
     function _executor() internal view virtual returns (address) {

+ 1 - 1
contracts/governance/IGovernor.sol

@@ -334,7 +334,7 @@ interface IGovernor is IERC165, IERC6372 {
     function hasVoted(uint256 proposalId, address account) external view returns (bool);
 
     /**
-     * @dev Create a new proposal. Vote start after a delay specified by {IGovernor-votingDelay} and lasts for a
+     * @dev Create a new proposal. Vote starts after a delay specified by {IGovernor-votingDelay} and lasts for a
      * duration specified by {IGovernor-votingPeriod}.
      *
      * Emits a {ProposalCreated} event.

+ 1 - 1
contracts/governance/extensions/GovernorTimelockControl.sol

@@ -9,7 +9,7 @@ import {SafeCast} from "../../utils/math/SafeCast.sol";
 
 /**
  * @dev Extension of {Governor} that binds the execution process to an instance of {TimelockController}. This adds a
- * delay, enforced by the {TimelockController} to all successful proposal (in addition to the voting duration). The
+ * delay, enforced by the {TimelockController} to all successful proposals (in addition to the voting duration). The
  * {Governor} needs the proposer (and ideally the executor and canceller) roles for the {Governor} to work properly.
  *
  * Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus,