fix: Fix some docs typos of FlashLoan package

aave · Sep 8, 2021 · eb0d5d8 · eb0d5d8
1 parent dd51e3a
commit eb0d5d8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/contracts/flashloan/base/FlashLoanReceiverBase.sol b/contracts/flashloan/base/FlashLoanReceiverBase.sol
@@ -6,12 +6,11 @@ import {IPoolAddressesProvider} from '../../interfaces/IPoolAddressesProvider.so
 import {IPool} from '../../interfaces/IPool.sol';
 
 /**
-* @title FlashLoanReceiverBase
-* @notice Base contract to develop flashloan-receiver contracts
-* @author Aave
+ * @title FlashLoanReceiverBase
+ * @author Aave
+ * @notice Base contract to develop a flashloan-receiver contract.
  */
 abstract contract FlashLoanReceiverBase is IFlashLoanReceiver {
-
   IPoolAddressesProvider public immutable override ADDRESSES_PROVIDER;
   IPool public immutable override POOL;
 

diff --git a/contracts/flashloan/interfaces/IFlashLoanReceiver.sol b/contracts/flashloan/interfaces/IFlashLoanReceiver.sol
@@ -5,23 +5,22 @@ import {IPoolAddressesProvider} from '../../interfaces/IPoolAddressesProvider.so
 import {IPool} from '../../interfaces/IPool.sol';
 
 /**
- * @title IFlashLoanReceiver interface
- * @notice Interface for the Aave fee IFlashLoanReceiver.
+ * @title IFlashLoanReceiver
  * @author Aave
+ * @notice Defines the basic interface of a flashloan-receiver contract.
  * @dev Implement this interface to develop a flashloan-compatible flashLoanReceiver contract
  **/
 interface IFlashLoanReceiver {
   /**
    * @notice Executes an operation after receiving the flash-borrowed assets
    * @dev Ensure the contract is able to return the debt + premium, so has
    *      enough funds to repay and approve the Pool to pull the total amount
-   * @dev Should return True if the operation is executed successfully
    * @param assets The addresses of the flash-borrowed assets
    * @param amounts The amounts of the flash-borrowed assets
    * @param premiums The fee of each flash-borrowed asset
    * @param initiator The address of the flashloan initiator
    * @param params The byte-encoded params passed when initiating the flashloan
-   * @return True if the execution succeds, false otherwise
+   * @return True if the execution of the operation succeds, false otherwise
    */
   function executeOperation(
     address[] calldata assets,