Fix typographical errors (OpenZeppelin#5171)

Amxx · Aug 30, 2024 · c51cc4d · c51cc4d
1 parent e995abf
commit c51cc4d
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 11 deletions.
diff --git a/contracts/access/manager/AccessManager.sol b/contracts/access/manager/AccessManager.sol
@@ -687,7 +687,7 @@ contract AccessManager is Context, Multicall, IAccessManager {
 
         (bool adminRestricted, uint64 roleId, uint32 operationDelay) = _getAdminRestrictions(data);
 
-        // isTragetClosed apply to non-admin-restricted function
+        // isTargetClosed apply to non-admin-restricted function
         if (!adminRestricted && isTargetClosed(address(this))) {
             return (false, 0);
         }

diff --git a/contracts/utils/StorageSlot.sol b/contracts/utils/StorageSlot.sol
@@ -88,7 +88,7 @@ library StorageSlot {
     }
 
     /**
-     * @dev Returns an `BooleanSlot` with member `value` located at `slot`.
+     * @dev Returns a `BooleanSlot` with member `value` located at `slot`.
      */
     function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
         assembly ("memory-safe") {
@@ -97,7 +97,7 @@ library StorageSlot {
     }
 
     /**
-     * @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
+     * @dev Returns a `Bytes32Slot` with member `value` located at `slot`.
      */
     function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
         assembly ("memory-safe") {
@@ -106,7 +106,7 @@ library StorageSlot {
     }
 
     /**
-     * @dev Returns an `Uint256Slot` with member `value` located at `slot`.
+     * @dev Returns a `Uint256Slot` with member `value` located at `slot`.
      */
     function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
         assembly ("memory-safe") {
@@ -115,7 +115,7 @@ library StorageSlot {
     }
 
     /**
-     * @dev Returns an `Int256Slot` with member `value` located at `slot`.
+     * @dev Returns a `Int256Slot` with member `value` located at `slot`.
      */
     function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
         assembly ("memory-safe") {
@@ -124,7 +124,7 @@ library StorageSlot {
     }
 
     /**
-     * @dev Returns an `StringSlot` with member `value` located at `slot`.
+     * @dev Returns a `StringSlot` with member `value` located at `slot`.
      */
     function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
         assembly ("memory-safe") {
@@ -142,7 +142,7 @@ library StorageSlot {
     }
 
     /**
-     * @dev Returns an `BytesSlot` with member `value` located at `slot`.
+     * @dev Returns a `BytesSlot` with member `value` located at `slot`.
      */
     function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
         assembly ("memory-safe") {

diff --git a/contracts/utils/math/Math.sol b/contracts/utils/math/Math.sol
@@ -232,7 +232,7 @@ library Math {
     /**
      * @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
      *
-     * If n is a prime, then Z/nZ is a field. In that case all elements are inversible, expect 0.
+     * If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
      * If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
      *
      * If the input value is not inversible, 0 is returned.

diff --git a/contracts/utils/math/SignedMath.sol b/contracts/utils/math/SignedMath.sol
@@ -58,10 +58,10 @@ library SignedMath {
             // Since `n` is a signed integer, the generated bytecode will use the SAR opcode to perform the right shift,
             // taking advantage of the most significant (or "sign" bit) in two's complement representation.
             // This opcode adds new most significant bits set to the value of the previous most significant bit. As a result,
-            // the mask will either be `bytes(0)` (if n is positive) or `~bytes32(0)` (if n is negative).
+            // the mask will either be `bytes32(0)` (if n is positive) or `~bytes32(0)` (if n is negative).
             int256 mask = n >> 255;
 
-            // A `bytes(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it.
+            // A `bytes32(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it.
             return uint256((n + mask) ^ mask);
         }
     }

diff --git a/scripts/generate/templates/StorageSlot.js b/scripts/generate/templates/StorageSlot.js
@@ -59,7 +59,9 @@ struct ${name}Slot {
 
 const get = ({ name }) => `\
 /**
- * @dev Returns an \`${name}Slot\` with member \`value\` located at \`slot\`.
+ * @dev Returns ${
+   name.toLowerCase().startsWith('a') ? 'an' : 'a'
+ } \`${name}Slot\` with member \`value\` located at \`slot\`.
  */
 function get${name}Slot(bytes32 slot) internal pure returns (${name}Slot storage r) {
     assembly ("memory-safe") {