Skip to content

Commit 76716fc

Browse files
committed
docs: minor update
1 parent bd0a71f commit 76716fc

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

src/ChainlinkOracle.sol

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,11 @@ contract ChainlinkOracle is IChainlinkOracle {
5858
/// - The quote feed prices don't overflow when multiplied.
5959
/// - The vault, if set, is ERC4626-compliant.
6060
/// @param baseVault Base vault. Pass address zero to omit this parameter.
61-
/// @param baseVaultConversionSample The sample amount of base vault shares used to convert to the underlying asset.
62-
/// Pass 1 if the oracle does not use a base vault. Should be chosen such that converting
63-
/// `baseVaultConversionSample` to
64-
/// assets has enough precision.
61+
/// @param baseVaultConversionSample The sample amount of base vault shares used to convert to underlying.
62+
/// Pass 1 if the base asset is not a vault. Should be chosen such that converting `baseVaultConversionSample` to assets has enough precision.
6563
/// @param quoteVault Quote vault. Pass address zero to omit this parameter.
66-
/// @param quoteVaultConversionSample The sample amount of quote vault shares used to convert to the underlying
67-
/// asset.
68-
/// Pass 1 if the oracle does not use a vault. Should be chosen such that converting `vaultConversionSample` to
69-
/// assets has enough precision.
64+
/// @param quoteVaultConversionSample The sample amount of quote vault shares used to convert to underlying.
65+
/// Pass 1 if the base asset is not a vault. Should be chosen such that converting `quoteVaultConversionSample` to assets has enough precision.
7066
/// @param baseFeed1 First base feed. Pass address zero if the price = 1.
7167
/// @param baseFeed2 Second base feed. Pass address zero if the price = 1.
7268
/// @param quoteFeed1 First quote feed. Pass address zero if the price = 1.

0 commit comments

Comments
 (0)