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: fix parameter comment in CollectProtocol event #1015

Closed
wants to merge 1 commit into from

Conversation

Caplost
Copy link

@Caplost Caplost commented Dec 17, 2024

Description

Fix incorrect parameter documentation in IUniswapV3PoolEvents.sol. The @param amount0 was duplicated instead of using @param amount1 for the second parameter.

Changes

  • Fix parameter documentation in CollectProtocol event to correctly document amount1 parameter instead of duplicating amount0

Before

/// @param amount0 The amount of token0 protocol fees that is withdrawn
/// @param amount0 The amount of token1 protocol fees that is withdrawn

After

/// @param amount0 The amount of token0 protocol fees that is withdrawn
/// @param amount1 The amount of token1 protocol fees that is withdrawn

Type of change

Documentation update (non-breaking change)

Checklist

  • Documentation update only
  • No code changes
  • No breaking changes

- Fix incorrect parameter documentation in IUniswapV3PoolEvents.sol
- Change duplicated @param amount0 to @param amount1
Copy link

stale bot commented Feb 15, 2025

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the wontfix label Feb 15, 2025
@stale stale bot closed this Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant