From 29dd59b5f9436ea0b92e34de7ec57d44abf36357 Mon Sep 17 00:00:00 2001 From: MathisGD <74971347+MathisGD@users.noreply.github.com> Date: Wed, 7 Aug 2024 11:25:10 +0200 Subject: [PATCH] docs: minor fixes Co-authored-by: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com> Signed-off-by: MathisGD <74971347+MathisGD@users.noreply.github.com> --- src/MetaMorpho.sol | 2 +- src/interfaces/IMetaMorpho.sol | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/MetaMorpho.sol b/src/MetaMorpho.sol index 51766d25..2f5d69ca 100644 --- a/src/MetaMorpho.sol +++ b/src/MetaMorpho.sol @@ -883,7 +883,7 @@ contract MetaMorpho is ERC4626, ERC20Permit, Ownable2Step, Multicall, IMetaMorph emit EventsLib.AccrueInterest(newTotalAssets, feeShares); } - /// @dev Computes and return the feeShares to mint, the new totalAssets and the new lostAssets. + /// @dev Computes and returns the `feeShares` to mint, the new `totalAssets` and the new `lostAssets`. /// @return feeShares the shares to mint to `feeRecipient`. /// @return newTotalAssets the new totalSupply. /// @return newLostAssets the new lostAssets. diff --git a/src/interfaces/IMetaMorpho.sol b/src/interfaces/IMetaMorpho.sol index 0190da99..4e17649f 100644 --- a/src/interfaces/IMetaMorpho.sol +++ b/src/interfaces/IMetaMorpho.sol @@ -75,7 +75,8 @@ interface IMetaMorphoBase { /// triggered (deposit/mint/withdraw/redeem/setFee/setFeeRecipient). function lastTotalAssets() external view returns (uint256); - /// @notice Stores the missing assets due to realised bad debt. + /// @notice Stores the missing assets due to realized bad debt. + /// @dev To let vault users recover the lost funds, one can supply directly on the market where the bad debt has been realized on behalf of the vault. function lostAssets() external view returns (uint256); /// @notice Submits a `newTimelock`.