fix: I4: Typos and missing documentation

Author: piesrtasty

src/contracts/tokens/RewardDistributor.sol

@@ -11,6 +11,7 @@ import {IRewardDistributor} from '@interfaces/tokens/IRewardDistributor.sol';
 import {Authorizable} from '@contracts/utils/Authorizable.sol';
 import {Modifiable} from '@contracts/utils/Modifiable.sol';
 
+import {Assertions} from '@libraries/Assertions.sol';
 import {Encoding} from '@libraries/Encoding.sol';
 /**
  * @title  RewardDistributor
@@ -20,7 +21,7 @@ import {Encoding} from '@libraries/Encoding.sol';
 contract RewardDistributor is Authorizable, Modifiable, Pausable, IRewardDistributor {
   using Encoding for bytes;
   using SafeERC20 for IERC20;
-
+  using Assertions for uint256;
   // --- Data ---
 
   /// @inheritdoc IRewardDistributor
@@ -101,7 +102,7 @@ contract RewardDistributor is Authorizable, Modifiable, Pausable, IRewardDistrib
   }
 
   /// @inheritdoc IRewardDistributor
-  function emergencyWidthdraw(address _rescueReceiver, address _token, uint256 _wad) external isAuthorized {
+  function emergencyWithdraw(address _rescueReceiver, address _token, uint256 _wad) external isAuthorized {
     if (_token == address(0)) {
       revert RewardDistributor_InvalidTokenAddress();
     }
@@ -137,4 +138,9 @@ contract RewardDistributor is Authorizable, Modifiable, Pausable, IRewardDistrib
     else if (_param == 'rootSetter') rootSetter = _address;
     else revert UnrecognizedParam();
   }
+
+  /// @inheritdoc Modifiable
+  function _validateParameters() internal view override {
+    epochDuration.assertGt(0);
+  }
 }

src/contracts/tokens/StakingManager.sol

@@ -98,7 +98,7 @@ contract StakingManager is Authorizable, Modifiable, IStakingManager {
   /**
    * @param  _protocolToken Address of the ProtocolToken contract
    * @param  _stakingToken Address of the StakingToken contract
-   * @param  _cooldownPeriod Address of the StakingToken contract
+   * @param  _cooldownPeriod Amount of time before a user can withdraw their staked tokens
    */
   constructor(
     address _protocolToken,

src/interfaces/tokens/IRewardDistributor.sol

@@ -147,5 +147,5 @@ interface IRewardDistributor is IAuthorizable, IModifiable {
    * @param _token Address of the token
    * @param _wad Amount of reward tokens to withdraw
    */
-  function emergencyWidthdraw(address _rescueReceiver, address _token, uint256 _wad) external;
+  function emergencyWithdraw(address _rescueReceiver, address _token, uint256 _wad) external;
 }

src/interfaces/tokens/IStakingManager.sol

@@ -180,6 +180,7 @@ interface IStakingManager is IAuthorizable, IModifiable {
   }
 
   struct StakingManagerParams {
+    // Amount of time before a user can withdraw their staked tokens
     uint256 cooldownPeriod;
   }
 

test/unit/RewardDistributor.t.sol

@@ -261,31 +261,31 @@ contract Unit_RewardDistributor_EmergencyWithdrawal is Base {
     vm.expectEmit(true, true, true, true);
     emit RewardDistributorEmergencyWithdrawal(rescueReceiver, address(mockRewardToken), RESCUE_AMOUNT);
     vm.prank(authorizedAccount);
-    rewardDistributor.emergencyWidthdraw(rescueReceiver, address(mockRewardToken), RESCUE_AMOUNT);
+    rewardDistributor.emergencyWithdraw(rescueReceiver, address(mockRewardToken), RESCUE_AMOUNT);
   }
 
   function test_Revert_EmergencyWithdrawal_NotAuthorized() public {
     address rescueReceiver = makeAddr('rescueReceiver');
 
     vm.prank(user);
     vm.expectRevert(IAuthorizable.Unauthorized.selector);
-    rewardDistributor.emergencyWidthdraw(rescueReceiver, address(mockRewardToken), RESCUE_AMOUNT);
+    rewardDistributor.emergencyWithdraw(rescueReceiver, address(mockRewardToken), RESCUE_AMOUNT);
   }
 
   function test_Revert_EmergencyWithdrawal_InvalidTokenAddress() public {
     address rescueReceiver = makeAddr('rescueReceiver');
 
     vm.prank(authorizedAccount);
     vm.expectRevert(IRewardDistributor.RewardDistributor_InvalidTokenAddress.selector);
-    rewardDistributor.emergencyWidthdraw(rescueReceiver, address(0), RESCUE_AMOUNT);
+    rewardDistributor.emergencyWithdraw(rescueReceiver, address(0), RESCUE_AMOUNT);
   }
 
   function test_Revert_EmergencyWithdrawal_InvalidAmount() public {
     address rescueReceiver = makeAddr('rescueReceiver');
 
     vm.prank(authorizedAccount);
     vm.expectRevert(IRewardDistributor.RewardDistributor_InvalidAmount.selector);
-    rewardDistributor.emergencyWidthdraw(rescueReceiver, address(mockRewardToken), 0);
+    rewardDistributor.emergencyWithdraw(rescueReceiver, address(mockRewardToken), 0);
   }
 }