Typos and other minor fixes (group n°5) (#5959)

Signed-off-by: Nikita Khateev <nikita.khateev@openzeppelin.com>
Signed-off-by: dulanting <dulanting@outlook.jp>
Co-authored-by: strmfos <155266597+strmfos@users.noreply.github.com>
Co-authored-by: Faizan <121456637+mdfaizanaquil@users.noreply.github.com>
Co-authored-by: sashaodessa <140454972+sashaodessa@users.noreply.github.com>
Co-authored-by: dulanting <dulanting@outlook.jp>
Co-authored-by: Nikita Khateev <nikita.khateev@gmail.com>
Co-authored-by: ernestognw <ernestognw@gmail.com>
Co-authored-by: Alvarez <140459501+prestoalvarez@users.noreply.github.com>
Co-authored-by: Gengar <creeptogengar@gmail.com>
Co-authored-by: forkfury <forkfury@gmail.com>
Co-authored-by: radik878 <radikpadik76@gmail.com>
Co-authored-by: Adam <lil22duckling@gmail.com>
Co-authored-by: KevinK <31565174+kevzzsk@users.noreply.github.com>
Co-authored-by: Ragnar <rodiondenmark@gmail.com>
Co-authored-by: VolodymyrBg <aqdrgg19@gmail.com>
Co-authored-by: sashass1315 <sashass1315@gmail.com>
Co-authored-by: GarmashAlex <garmasholeksii@gmail.com>
Co-authored-by: phrwlk <phrwlk7@gmail.com>
Co-authored-by: Forostovec <ilonaforostovec22@gmail.com>
Co-authored-by: Avory <avorycorelli@gmail.com>
Co-authored-by: Doryu <anna.shuraeva16@gmail.com>
Co-authored-by: Nixuewyreks <kirilzhezherun@gmail.com>
Co-authored-by: Snezhkko <snezhkodaria38@gmail.com>
Co-authored-by: MozirDmitriy <dmitriymozir@gmail.com>
Co-authored-by: Galoretka <galoretochka@gmail.com>
Co-authored-by: Micke <155267459+reallesee@users.noreply.github.com>
Co-authored-by: bigbear <155267841+aso20455@users.noreply.github.com>
Co-authored-by: Fallengirl <155266340+Fallengirl@users.noreply.github.com>
Co-authored-by: emmmm <155267286+eeemmmmmm@users.noreply.github.com>
Co-authored-by: Bashmunta <georgebashmunta@gmail.com>
Co-authored-by: Fibonacci747 <albertofibonacci12@gmail.com>
Co-authored-by: James Niken <155266991+dizer-ti@users.noreply.github.com>
Co-authored-by: maradini77 <140460067+maradini77@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Tomass <155266802+zeroprooff@users.noreply.github.com>
Co-authored-by: ANtutov <tutovanton26@gmail.com>
Co-authored-by: Denever <140512416+denevertt@users.noreply.github.com>
Co-authored-by: Nina <152422240+ninastef@users.noreply.github.com>
Co-authored-by: Adrian <hawkadrian10@gmail.com>
Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com>
Co-authored-by: anim001k <140460766+anim001k@users.noreply.github.com>
Co-authored-by: iPLAY888 <133153661+letmehateu@users.noreply.github.com>
Co-authored-by: bobtajson <152420524+bobtajson@users.noreply.github.com>
Co-authored-by: yyhrnk <yaroslavnerest@gmail.com>

Author: 44 people

CHANGELOG.md

@@ -25,7 +25,7 @@
 
 ### Deprecation
 
-- `Initializable` and `UUPSUpgradeable` are no longer transpiled. An alias is present in the `@openzeppelin/contracts-upgradeable` package that redirect to the corresponding file in `@openzeppelin/contracts`. These alias will be removed in the next major release. Developers are advised to update their imports to get these files directly from the `@openzeppelin/contracts` package. [#5941](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5941)
+- `Initializable` and `UUPSUpgradeable` are no longer transpiled. Aliases are present in the `@openzeppelin/contracts-upgradeable` package that redirect to the corresponding files in `@openzeppelin/contracts`. These aliases will be removed in the next major release. Developers are advised to update their imports to get these files directly from the `@openzeppelin/contracts` package. [#5941](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5941)
 - `ECDSA` signature malleability protection is partly deprecated. See documentation for more details. [#5814](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5814)
 
 ### Changes by category
@@ -93,7 +93,7 @@
 
 ### Pragma changes
 
-- Reduced pragma requirement of interface files
+- Reduced pragma requirement of interface files.
 
 ### Changes by category
 

GUIDELINES.md

@@ -125,7 +125,7 @@ In addition to the official Solidity Style Guide we have a number of other conve
   ```
 
 * Contracts not intended to be used standalone should be marked abstract
-  so they are required to be inherited to other contracts.
+  so they are required to be inherited by other contracts.
 
   ```solidity
   abstract contract AccessControl is ..., {

contracts/access/AccessControl.sol

@@ -65,7 +65,7 @@ abstract contract AccessControl is Context, IAccessControl, ERC165 {
         _;
     }
 
-    /// @inheritdoc IERC165
+    /// @inheritdoc ERC165
     function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
         return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
     }

contracts/access/extensions/AccessControlDefaultAdminRules.sol

@@ -315,7 +315,7 @@ abstract contract AccessControlDefaultAdminRules is IAccessControlDefaultAdminRu
     /**
      * @dev Setter of the tuple for pending admin and its schedule.
      *
-     * May emit a DefaultAdminTransferCanceled event.
+     * May emit a {DefaultAdminTransferCanceled} event.
      */
     function _setPendingDefaultAdmin(address newAdmin, uint48 newSchedule) private {
         (, uint48 oldSchedule) = pendingDefaultAdmin();
@@ -333,7 +333,7 @@ abstract contract AccessControlDefaultAdminRules is IAccessControlDefaultAdminRu
     /**
      * @dev Setter of the tuple for pending delay and its schedule.
      *
-     * May emit a DefaultAdminDelayChangeCanceled event.
+     * May emit a {DefaultAdminDelayChangeCanceled} event.
      */
     function _setPendingDelay(uint48 newDelay, uint48 newSchedule) private {
         uint48 oldSchedule = _pendingDelaySchedule;

contracts/access/extensions/IAccessControlDefaultAdminRules.sol

@@ -103,7 +103,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * Emits a DefaultAdminRoleChangeStarted event.
+     * Emits a {DefaultAdminTransferScheduled} event.
      */
     function beginDefaultAdminTransfer(address newAdmin) external;
 
@@ -116,7 +116,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * May emit a DefaultAdminTransferCanceled event.
+     * May emit a {DefaultAdminTransferCanceled} event.
      */
     function cancelDefaultAdminTransfer() external;
 
@@ -160,7 +160,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * Emits a DefaultAdminDelayChangeScheduled event and may emit a DefaultAdminDelayChangeCanceled event.
+     * Emits a {DefaultAdminDelayChangeScheduled} event and may emit a {DefaultAdminDelayChangeCanceled} event.
      */
     function changeDefaultAdminDelay(uint48 newDelay) external;
 
@@ -171,7 +171,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * May emit a DefaultAdminDelayChangeCanceled event.
+     * May emit a {DefaultAdminDelayChangeCanceled} event.
      */
     function rollbackDefaultAdminDelay() external;
 

contracts/access/manager/IAccessManager.sol

@@ -36,7 +36,7 @@ interface IAccessManager {
      *
      * NOTE: The meaning of the `since` argument depends on the `newMember` argument.
      * If the role is granted to a new member, the `since` argument indicates when the account becomes a member of the role,
-     * otherwise it indicates the execution delay for this account and roleId is updated.
+     * otherwise it indicates the timestamp when the execution delay update takes effect for this account and roleId.
      */
     event RoleGranted(uint64 indexed roleId, address indexed account, uint32 delay, uint48 since, bool newMember);
 
@@ -196,6 +196,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
      *
      * Emits a {RoleLabel} event.
      */
@@ -254,6 +255,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
      *
      * Emits a {RoleAdminChanged} event
      */
@@ -265,6 +267,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
      *
      * Emits a {RoleGuardianChanged} event
      */
@@ -276,6 +279,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `PUBLIC_ROLE`
      *
      * Emits a {RoleGrantDelayChanged} event.
      */

contracts/account/extensions/draft-AccountERC7579.sol

@@ -401,7 +401,7 @@ abstract contract AccountERC7579 is Account, IERC1271, IERC7579Execution, IERC75
      * actual copy. However, this would require `_installModule` to get a calldata bytes object instead of a memory
      * bytes object. This would prevent calling `_installModule` from a contract constructor and would force the use
      * of external initializers. That may change in the future, as most accounts will probably be deployed as
-     * clones/proxy/ERC-7702 delegates and therefore rely on initializers anyway.
+     * clones/proxy/EIP-7702 delegates and therefore rely on initializers anyway.
      */
     function _decodeFallbackData(
         bytes memory data

contracts/account/utils/EIP7702Utils.sol

@@ -6,7 +6,7 @@ pragma solidity ^0.8.20;
 /**
  * @dev Library with common EIP-7702 utility functions.
  *
- * See https://eips.ethereum.org/EIPS/eip-7702[ERC-7702].
+ * See https://eips.ethereum.org/EIPS/eip-7702[EIP-7702].
  */
 library EIP7702Utils {
     bytes3 internal constant EIP7702_PREFIX = 0xef0100;

contracts/governance/Governor.sol

@@ -735,7 +735,7 @@ abstract contract Governor is Context, ERC165, EIP712, Nonces, IGovernor, IERC72
         return currentState;
     }
 
-    /*
+    /**
      * @dev Check if the proposer is authorized to submit a proposal with the given description.
      *
      * If the proposal description ends with `#proposer=0x???`, where `0x???` is an address written as a hex string
@@ -746,6 +746,7 @@ abstract contract Governor is Context, ERC165, EIP712, Nonces, IGovernor, IERC72
      * which would result in a different proposal id.
      *
      * If the description does not match this pattern, it is unrestricted and anyone can submit it. This includes:
+     *
      * - If the `0x???` part is not a valid hex string.
      * - If the `0x???` part is a valid hex string, but does not contain exactly 40 hex digits.
      * - If it ends with the expected suffix followed by newlines or other whitespace.

contracts/governance/README.adoc

@@ -135,7 +135,7 @@ In a governance system, the {TimelockController} contract is in charge of introd
 [[timelock-operation]]
 ==== Operation structure
 
-Operation executed by the xref:api:governance.adoc#TimelockController[`TimelockController`] can contain one or multiple subsequent calls. Depending on whether you need to multiple calls to be executed atomically, you can either use simple or batched operations.
+Operation executed by the xref:api:governance.adoc#TimelockController[`TimelockController`] can contain one or multiple subsequent calls. Depending on whether you need multiple calls to be executed atomically, you can either use simple or batched operations.
 
 Both operations contain:
 
@@ -183,7 +183,7 @@ The admins are in charge of managing proposers and executors. For the timelock t
 
 The proposers are in charge of scheduling (and cancelling) operations. This is a critical role, that should be given to governing entities. This could be an EOA, a multisig, or a DAO.
 
-WARNING: *Proposer fight:* Having multiple proposers, while providing redundancy in case one becomes unavailable, can be dangerous. As proposer have their say on all operations, they could cancel operations they disagree with, including operations to remove them for the proposers.
+WARNING: *Proposer fight:* Having multiple proposers, while providing redundancy in case one becomes unavailable, can be dangerous. Proposers have a say on all operations--they could cancel operations they disagree with, including operations to remove them from the list of proposers.
 
 This role is identified by the *PROPOSER_ROLE* value: `0xb09aa5aeb3702cfd50b6b62bc4532604938f21248a27a1d5ca736082b6819cc1`