Merge pull request #54 from mantlenetworkio/afk/audit/oz-n-04

fix: [OZ][N-04] Imprecise docstrings
mantlenetworkio · Jun 14, 2023 · 8e23955 · 8e23955
2 parents fc61c91 + 0e76225
commit 8e23955
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/contracts/L1/L1MantleToken.sol b/contracts/L1/L1MantleToken.sol
@@ -115,7 +115,7 @@ contract L1MantleToken is
     /// @dev emits a {MintCapNumeratorChanged} event
     /// @dev Requirements:
     ///     - The caller must be the contract owner
-    ///     - parameter {_mintCapNumerator} must be less than or equal to {MINT_CAP_MAX_NUMERATOR}
+    ///     - {_mintCapNumerator} must be less than or equal to {MINT_CAP_MAX_NUMERATOR}
     function setMintCapNumerator(uint256 _mintCapNumerator) public onlyOwner {
         if (_mintCapNumerator > MINT_CAP_MAX_NUMERATOR) {
             revert MantleToken_MintCapNumeratorTooLarge(_mintCapNumerator, MINT_CAP_MAX_NUMERATOR);

diff --git a/contracts/Migration/MantleTokenMigrator.sol b/contracts/Migration/MantleTokenMigrator.sol
@@ -156,6 +156,7 @@ contract MantleTokenMigrator {
     ///     - The caller must have approved this contract to spend at least {_amount} of their BIT tokens
     ///     - The caller must have a balance of at least {_amount} of BIT tokens
     ///     - The contract must not be halted
+    ///     - {_amount} must be non-zero
     /// @param _amount The amount of BIT tokens to swap
     function migrateBIT(uint256 _amount) external onlyWhenNotHalted {
         _migrateTokens(_amount);
@@ -166,6 +167,7 @@ contract MantleTokenMigrator {
     /// @dev Requirements:
     ///     - The caller must have approved this contract to spend at least {_amount} of their BIT tokens
     ///     - The caller must have a balance of at least {_amount} of BIT tokens
+    ///     - {_amount} must be non-zero
     /// @param _amount The amount of BIT tokens to swap
     function _migrateTokens(uint256 _amount) internal {
         if (_amount == 0) revert MantleTokenMigrator_ZeroSwap();