fix: Fix typos in docstrings

aave · Jan 4, 2022 · 51b95e0 · 51b95e0
1 parent 3186d4f
commit 51b95e0
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/contracts/interfaces/IAToken.sol b/contracts/interfaces/IAToken.sol
@@ -147,7 +147,7 @@ interface IAToken is IERC20, IScaledBalanceToken, IInitializableAToken {
 
   /**
    * @notice Get the domain separator for the token
-   * @dev Return cached value if chainId matched cache, otherwise recomputes separator
+   * @dev Return cached value if chainId matches cache, otherwise recomputes separator
    * @return The domain separator of the token at current chain
    */
   function DOMAIN_SEPARATOR() external view returns (bytes32);

diff --git a/contracts/protocol/pool/DefaultReserveInterestRateStrategy.sol b/contracts/protocol/pool/DefaultReserveInterestRateStrategy.sol
@@ -58,7 +58,7 @@ contract DefaultReserveInterestRateStrategy is IReserveInterestRateStrategy {
   /// Slope of the stable interest curve when utilization rate > OPTIMAL_UTILIZATION_RATE. Expressed in ray
   uint256 internal immutable _stableRateSlope2;
 
-  /// Premium on top of variable rate slope below optimal utilization rate for base stable borrowing rate
+  /// Premium on top of `_variableRateSlope1` for base stable borrowing rate
   uint256 internal immutable _baseStableRateOffset;
 
   /// Additional premium applied to stable rate when stable debt surpass `OPTIMAL_STABLE_TO_TOTAL_DEBT_RATIO`

diff --git a/contracts/protocol/tokenization/IncentivizedERC20.sol b/contracts/protocol/tokenization/IncentivizedERC20.sol
@@ -42,7 +42,7 @@ abstract contract IncentivizedERC20 is Context, IERC20, IERC20Detailed {
   /// Map of users address and their state data (userAddress => userStateData)
   mapping(address => UserState) internal _userState;
 
-  /// Map of allowances (delegate => delegatee => allowanceAmount)
+  /// Map of allowances (delegator => delegatee => allowanceAmount)
   mapping(address => mapping(address => uint256)) private _allowances;
 
   uint256 internal _totalSupply;
@@ -290,7 +290,7 @@ abstract contract IncentivizedERC20 is Context, IERC20, IERC20Detailed {
 
   /**
    * @notice Get the domain separator for the token
-   * @dev Return cached value if chainId matched cache, otherwise recomputes separator
+   * @dev Return cached value if chainId matches cache, otherwise recomputes separator
    * @return The domain separator of the token at current chain
    */
   function DOMAIN_SEPARATOR() public view virtual returns (bytes32) {

diff --git a/contracts/protocol/tokenization/StableDebtToken.sol b/contracts/protocol/tokenization/StableDebtToken.sol
@@ -26,7 +26,7 @@ contract StableDebtToken is IStableDebtToken, DebtTokenBase {
 
   uint256 public constant DEBT_TOKEN_REVISION = 0x2;
 
-  /// Map of users address and the timestamp of their last update (userAddress => lastTimestampUpdate)
+  /// Map of users address and the timestamp of their last update (userAddress => lastUpdateTimestamp)
   mapping(address => uint40) internal _timestamps;
 
   uint128 _avgStableRate;

diff --git a/contracts/protocol/tokenization/base/DebtTokenBase.sol b/contracts/protocol/tokenization/base/DebtTokenBase.sol
@@ -140,7 +140,7 @@ abstract contract DebtTokenBase is
    * @notice Updates the borrow allowance of a user on the specific debt token.
    * @param delegator The address delegating the borrowing power
    * @param delegatee The address receiving the delegated borrowing power
-   * @param amount The maximum amount being delegated.
+   * @param amount The allowance amount being delegated.
    **/
   function _approveDelegation(
     address delegator,
@@ -155,7 +155,7 @@ abstract contract DebtTokenBase is
    * @notice Decreases the borrow allowance of a user on the specific debt token.
    * @param delegator The address delegating the borrowing power
    * @param delegatee The address receiving the delegated borrowing power
-   * @param amount The allowance amount to decrease
+   * @param amount The amount to subtract from the current allowance
    **/
   function _decreaseBorrowAllowance(
     address delegator,