Skip to content

Commit b25befb

Browse files
CJ42tsudmi
andauthored
docs: fix mixed up Natspec comment for convertToShares/Assets + improve comment (#98)
Co-authored-by: Dmitri Tsumak <[email protected]>
1 parent 2dbfd14 commit b25befb

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

contracts/interfaces/IOsTokenVaultController.sol

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,16 +113,16 @@ interface IOsTokenVaultController {
113113
function totalAssets() external view returns (uint256);
114114

115115
/**
116-
* @notice Converts shares to assets
116+
* @notice Converts assets to shares
117117
* @param assets The amount of assets to convert to shares
118-
* @return shares The amount of shares that the OsToken would exchange for the amount of assets provided
118+
* @return shares The amount of OsToken shares obtained when exchanging with the amount of assets provided
119119
*/
120120
function convertToShares(uint256 assets) external view returns (uint256 shares);
121121

122122
/**
123-
* @notice Converts assets to shares
123+
* @notice Converts shares to assets
124124
* @param shares The amount of shares to convert to assets
125-
* @return assets The amount of assets that the OsToken would exchange for the amount of shares provided
125+
* @return assets The amount of assets obtained when exchanging with the amount of OsToken shares provided
126126
*/
127127
function convertToAssets(uint256 shares) external view returns (uint256 assets);
128128

0 commit comments

Comments
 (0)