Skip to content

Commit

Permalink
docs: fix mixed up Natspec comment for convertToShares/Assets + imp…
Browse files Browse the repository at this point in the history
…rove comment (#98)

Co-authored-by: Dmitri Tsumak <[email protected]>
  • Loading branch information
CJ42 and tsudmi authored Dec 5, 2024
1 parent 2dbfd14 commit b25befb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions contracts/interfaces/IOsTokenVaultController.sol
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,16 @@ interface IOsTokenVaultController {
function totalAssets() external view returns (uint256);

/**
* @notice Converts shares to assets
* @notice Converts assets to shares
* @param assets The amount of assets to convert to shares
* @return shares The amount of shares that the OsToken would exchange for the amount of assets provided
* @return shares The amount of OsToken shares obtained when exchanging with the amount of assets provided
*/
function convertToShares(uint256 assets) external view returns (uint256 shares);

/**
* @notice Converts assets to shares
* @notice Converts shares to assets
* @param shares The amount of shares to convert to assets
* @return assets The amount of assets that the OsToken would exchange for the amount of shares provided
* @return assets The amount of assets obtained when exchanging with the amount of OsToken shares provided
*/
function convertToAssets(uint256 shares) external view returns (uint256 assets);

Expand Down

0 comments on commit b25befb

Please sign in to comment.