Skip to content

Commit 3859186

Browse files
committed
docs: minor improvement
1 parent 76716fc commit 3859186

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

src/ChainlinkOracle.sol

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ contract ChainlinkOracle is IChainlinkOracle {
5757
/// - The vault's sample shares quoted as assets and the base feed prices don't overflow when multiplied.
5858
/// - The quote feed prices don't overflow when multiplied.
5959
/// - The vault, if set, is ERC4626-compliant.
60+
/// @dev The base asset is the collateral token and the quote asset is the loan token.
6061
/// @param baseVault Base vault. Pass address zero to omit this parameter.
6162
/// @param baseVaultConversionSample The sample amount of base vault shares used to convert to underlying.
6263
/// Pass 1 if the base asset is not a vault. Should be chosen such that converting `baseVaultConversionSample` to assets has enough precision.

0 commit comments

Comments
 (0)