docs: improve ticks function return value documentation #1017
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Improve the documentation format for the
ticks()
function inIUniswapV3PoolState.sol
. This change enhances readability and maintains consistency with Solidity documentation standards.Changes
@return
tags for each return parameterBefore
/// @return liquidityGross the total amount of position liquidity that uses the pool either as tick lower or
/// tick upper,
/// liquidityNet how much liquidity changes when the pool price crosses the tick,
/// feeGrowthOutside0X128 the fee growth on the other side of the tick from the current tick in token0,
/// feeGrowthOutside1X128 the fee growth on the other side of the tick from the current tick in token1,
/// tickCumulativeOutside the cumulative tick value on the other side of the tick from the current tick
/// secondsPerLiquidityOutsideX128 the seconds spent per liquidity on the other side of the tick from the current tick,
/// secondsOutside the seconds spent on the other side of the tick from the current tick,
/// initialized Set to true if the tick is initialized, i.e. liquidityGross is greater than 0, otherwise equal to false.
After
/// @return liquidityGross The total amount of position liquidity that uses the pool either as tick lower or tick upper
/// @return liquidityNet How much liquidity changes when the pool price crosses the tick
/// @return feeGrowthOutside0X128 The fee growth on the other side of the tick from the current tick in token0
/// @return feeGrowthOutside1X128 The fee growth on the other side of the tick from the current tick in token1
/// @return tickCumulativeOutside The cumulative tick value on the other side of the tick from the current tick
/// @return secondsPerLiquidityOutsideX128 The seconds spent per liquidity on the other side of the tick from the current tick
/// @return secondsOutside The seconds spent on the other side of the tick from the current tick
/// @return initialized Set to true if the tick is initialized, i.e. liquidityGross is greater than 0, otherwise equal to false
Type of change
Documentation update (non-breaking change)
Checklist