Update doc for previewRepayDebt function

The docs were not updated after the function was modified in one of previous commits.
thesis · Aug 9, 2024 · deff46d · deff46d
1 parent 4d0bf44
commit deff46d
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/solidity/contracts/stBTC.sol b/solidity/contracts/stBTC.sol
@@ -528,8 +528,8 @@ contract stBTC is ERC4626Fees, PausableOwnable {
         return convertToAssets(balanceOf(account));
     }
 
-    /// @notice Previews the amount of shares that will be burned for the given
-    ///         amount of repaid debt assets.
+    /// @notice Previews the amount of assets that will be burned for the given
+    ///         amount of repaid shares.
     function previewRepayDebt(uint256 shares) public view returns (uint256) {
         return convertToAssets(shares);
     }