Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve ticks function return value documentation #1017

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Caplost
Copy link

@Caplost Caplost commented Dec 17, 2024

Description

Improve the documentation format for the ticks() function in IUniswapV3PoolState.sol. This change enhances readability and maintains consistency with Solidity documentation standards.

Changes

  • Add proper @return tags for each return parameter
  • Capitalize first letter of each return description
  • Remove unnecessary commas and line breaks
  • Maintain all technical details while improving readability
  • Keep consistent documentation format across the interface

Before

/// @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

  • Documentation update only
  • No code changes
  • No breaking changes
  • Improves readability while maintaining technical accuracy

- Add @return tags for all return parameters
- Improve documentation formatting and consistency
- Capitalize return value descriptions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant