Design Improvements: Spelling and grammar

Author: 0xSachinK

contracts/protocol/lib/PositionV2.sol

@@ -37,7 +37,7 @@ import { PreciseUnitMath } from "../../lib/PreciseUnitMath.sol";
  * CHANGELOG:
  * - `Position` library has all internal functions which are inlined to the module contract during compilation.
  * Inlining functions increases bytecode size of the module contract. This library contains the same functions
- * as `Position` library but all the functions have public/external access modifier. Thus, making this version 
+ * as `Position` library but all the functions have public/external access modifier. Thus, making this version
  * linkable which helps in reducing bytecode size of the module contract.
  */
 library PositionV2 {
@@ -62,7 +62,7 @@ library PositionV2 {
     function hasExternalPosition(ISetToken _setToken, address _component) public view returns(bool) {
         return _setToken.getExternalPositionModules(_component).length > 0;
     }
-    
+
     /**
      * Returns whether the SetToken component default position real unit is greater than or equal to units passed in.
      */
@@ -71,7 +71,7 @@ library PositionV2 {
     }
 
     /**
-     * Returns whether the SetToken component external position is greater than or equal to the real units passed in.
+     * Returns whether the SetToken component's external position is greater than or equal to the real units passed in.
      */
     function hasSufficientExternalUnits(
         ISetToken _setToken,
@@ -83,12 +83,12 @@ library PositionV2 {
         view
         returns(bool)
     {
-       return _setToken.getExternalPositionRealUnit(_component, _positionModule) >= _unit.toInt256();    
+       return _setToken.getExternalPositionRealUnit(_component, _positionModule) >= _unit.toInt256();
     }
 
     /**
      * If the position does not exist, create a new Position and add to the SetToken. If it already exists,
-     * then set the position units. If the new units is 0, remove the position. Handles adding/removing of 
+     * then set the position units. If the new units is 0, remove the position. Handles adding/removing of
      * components where needed (in light of potential external positions).
      *
      * @param _setToken           Address of SetToken being modified
@@ -114,7 +114,7 @@ library PositionV2 {
 
     /**
      * Update an external position and remove and external positions or components if necessary. The logic flows as follows:
-     * 1) If component is not already added then add component and external position. 
+     * 1) If component is not already added then add component and external position.
      * 2) If component is added but no existing external position using the passed module exists then add the external position.
      * 3) If the existing position is being added to then just update the unit and data
      * 4) If the position is being closed and no other external positions or default positions are associated with the component
@@ -191,7 +191,7 @@ library PositionV2 {
      * @return                    Notional tracked balance
      */
     function getDefaultTrackedBalance(ISetToken _setToken, address _component) external view returns(uint256) {
-        int256 positionUnit = _setToken.getDefaultPositionRealUnit(_component); 
+        int256 positionUnit = _setToken.getDefaultPositionRealUnit(_component);
         return _setToken.totalSupply().preciseMul(positionUnit.toUint256());
     }
 

contracts/protocol/modules/v2/PerpV2BasisTradingModule.sol

@@ -130,10 +130,10 @@ contract PerpV2BasisTradingModule is PerpV2LeverageModuleV2 {
     /* ============ External Functions ============ */
 
     /**
-     * @dev Reverts upon calling. Use `intialize(_setToken, _settings)` instead.
+     * @dev Reverts upon calling. Use `initialize(_setToken, _settings)` instead.
      */
     function initialize(ISetToken /*_setToken*/) public override(PerpV2LeverageModuleV2) {
-        revert("Use intialize(_setToken, _settings) instead");
+        revert("Use initialize(_setToken, _settings) instead");
     }
 
     /**
@@ -232,7 +232,7 @@ contract PerpV2BasisTradingModule is PerpV2LeverageModuleV2 {
     /**
      * @dev SETTOKEN ONLY: Removes this module from the SetToken, via call by the SetToken. Deletes
      * position mappings and fee states associated with SetToken. Resets settled funding to zero.
-     * Fees are not accrued in case reason for removing module is related to fee accrual.
+     * Fees are not accrued in case the reason for removing the module is related to fee accrual.
      *
      * NOTE: Function will revert if there is greater than a position unit amount of USDC of account value.
      */
@@ -463,7 +463,7 @@ contract PerpV2BasisTradingModule is PerpV2LeverageModuleV2 {
     }
 
     /**
-     * @dev Calculates manager and protocol fees on withdranwn funding amount and transfers them to
+     * @dev Calculates manager and protocol fees on withdrawn funding amount and transfers them to
      * their respective recipients (in USDC).
      *
      * @param _setToken     Instance of SetToken

contracts/protocol/modules/v2/PerpV2LeverageModuleV2.sol

@@ -555,7 +555,7 @@ contract PerpV2LeverageModuleV2 is ModuleBaseV2, ReentrancyGuard, Ownable, SetTo
     /**
      * @dev GOVERNANCE ONLY: Update max perpetual positions per SetToken. Only callable by governance.
      *
-     * @param _maxPerpPositionsPerSet       New max perpetual positons per set
+     * @param _maxPerpPositionsPerSet       New max perpetual positions per set
      */
     function updateMaxPerpPositionsPerSet(uint256 _maxPerpPositionsPerSet) external onlyOwner {
         maxPerpPositionsPerSet = _maxPerpPositionsPerSet;
@@ -1107,7 +1107,7 @@ contract PerpV2LeverageModuleV2 is ModuleBaseV2, ReentrancyGuard, Ownable, SetTo
      * @param _setToken                         Instance of the SetToken
      * @param _newExternalPositionUnit          Dynamically calculated externalPositionUnit
      * @return int256[]                         Components-length array with equity adjustment value at appropriate index
-     * @return int256[]                         Components-length array of zeroes (debt adjustements)
+     * @return int256[]                         Components-length array of zeroes (debt adjustments)
      */
     function _formatAdjustments(
         ISetToken _setToken,

deprecated/PerpV2LeverageModule.sol

@@ -271,7 +271,7 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, SetTokenA
      * token market prices and needs to be generated on the fly to be meaningful.
      *
      * In the tables below, basePositionUnit = baseTokenBalance / setTotalSupply.
-     * 
+     *
      * As a user when levering, e.g increasing the magnitude of your position, you'd trade as below
      * | ----------------------------------------------------------------------------------------------- |
      * | Type  |  Action | Goal                      | `quoteBoundQuantity`        | `baseQuantityUnits` |
@@ -318,7 +318,7 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, SetTokenA
         public
         nonReentrant
         onlyManagerAndValidSet(_setToken)
-    {        
+    {
         ActionInfo memory actionInfo = _createAndValidateActionInfo(
             _setToken,
             _baseToken,
@@ -413,7 +413,7 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, SetTokenA
         // `positions[setToken]` mapping stores an array of addresses. The base token addresses are removed from the array when the
         // corresponding base token positions are zeroed out. Since no positions exist when removing the module, the stored array should
         // already be empty, and the mapping can be deleted directly.
-        delete positions[setToken]; 
+        delete positions[setToken];
 
         // Try if unregister exists on any of the modules
         address[] memory modules = setToken.getModules();
@@ -563,8 +563,8 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, SetTokenA
 
     /**
      * @dev GOVERNANCE ONLY: Update max perpetual positions per SetToken. Only callable by governance.
-     * 
-     * @param _maxPerpPositionsPerSet       New max perpetual positons per set
+     *
+     * @param _maxPerpPositionsPerSet       New max perpetual positions per set
      */
     function updateMaxPerpPositionsPerSet(uint256 _maxPerpPositionsPerSet) external onlyOwner {
         maxPerpPositionsPerSet = _maxPerpPositionsPerSet;
@@ -1052,8 +1052,8 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, SetTokenA
 
         int256 baseBalance = perpAccountBalance.getBase(address(_setToken), _baseToken);
         int256 basePositionUnit = baseBalance.preciseDiv(totalSupply.toInt256());
-        
-        int256 baseNotional = _baseQuantityUnits == basePositionUnit.neg() 
+
+        int256 baseNotional = _baseQuantityUnits == basePositionUnit.neg()
             ? baseBalance.neg()         // To close position completely
             : _baseQuantityUnits.preciseMul(totalSupply.toInt256());
 
@@ -1134,7 +1134,7 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, SetTokenA
     function _syncPositionList(ISetToken _setToken) internal {
         address[] memory positionList = positions[_setToken];
         uint256 positionLength = positionList.length;
-        
+
         for (uint256 i = 0; i < positionLength; i++) {
             address currPosition = positionList[i];
             if (!_hasBaseBalance(_setToken, currPosition)) {
@@ -1236,7 +1236,7 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, SetTokenA
      * @param _components                       Array of components held by the SetToken
      * @param _newExternalPositionUnit          Dynamically calculated externalPositionUnit
      * @return int256[]                         Components-length array with equity adjustment value at appropriate index
-     * @return int256[]                         Components-length array of zeroes (debt adjustements)
+     * @return int256[]                         Components-length array of zeroes (debt adjustments)
      */
     function _formatAdjustments(
         ISetToken _setToken,