fix: Add minor changes to contract docs

aave · Sep 9, 2021 · 4f393aa · 4f393aa
1 parent dfc4b36
commit 4f393aa
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/contracts/interfaces/IAaveIncentivesController.sol b/contracts/interfaces/IAaveIncentivesController.sol
@@ -128,14 +128,14 @@ interface IAaveIncentivesController {
   ) external returns (uint256);
 
   /**
-   * @notice returns the unclaimed rewards of the user
+   * @notice Returns the unclaimed rewards of the user
    * @param user The address of the user
    * @return The unclaimed user rewards
    */
   function getUserUnclaimedRewards(address user) external view returns (uint256);
 
   /**
-   * @notice returns the user index for a specific asset
+   * @notice Returns the user index for a specific asset
    * @param user The address of the user
    * @param asset The asset to incentivize
    * @return The user index for the asset

diff --git a/contracts/interfaces/IRateOracle.sol b/contracts/interfaces/IRateOracle.sol
@@ -9,14 +9,14 @@ pragma solidity 0.8.6;
 
 interface IRateOracle {
   /**
-   * @notice returns the market borrow rate in ray
+   * @notice Returns the market borrow rate in ray
    * @param asset The asset to retrieve borrow rate for
    * @return The borrow rate for the given asset
    **/
   function getMarketBorrowRate(address asset) external view returns (uint256);
 
   /**
-   * @notice sets the market borrow rate. Rate value must be in ray
+   * @notice Sets the market borrow rate. Rate value must be in ray
    * @param asset The asset to set borrow rate for
    * @param rate The rate to use
    **/

diff --git a/contracts/protocol/libraries/aave-upgradeability/VersionedInitializable.sol b/contracts/protocol/libraries/aave-upgradeability/VersionedInitializable.sol
@@ -48,7 +48,7 @@ abstract contract VersionedInitializable {
   }
 
   /**
-   * @notice returns the revision number of the contract
+   * @notice Returns the revision number of the contract
    * @dev Needs to be defined in the inherited class as a constant.
    * @return The revision number
    **/