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

Constructor documentation mistakes/nits #211

Open
XavierEkkel opened this issue Jul 8, 2021 · 0 comments
Open

Constructor documentation mistakes/nits #211

XavierEkkel opened this issue Jul 8, 2021 · 0 comments
Labels
wontfix This will not be worked on

Comments

@XavierEkkel
Copy link

The documentation above the constructor for UniswapV3Staker.sol is currently:

    /// @param _factory the Uniswap V3 factory
    /// @param _nonfungiblePositionManager the NFT position manager contract address
    /// @param _maxIncentiveStartLeadTime the max duration of an incentive in seconds
    /// @param _maxIncentiveDuration the max amount of seconds into the future the incentive startTime can be set

It should be:

    /// @param _factory The Uniswap V3 Factory
    /// @param _nonfungiblePositionManager The nonfungible position manager with which this staking contract is compatible
    /// @param _maxIncentiveStartLeadTime The max amount of seconds into the future the incentive startTime can be set
    /// @param _maxIncentiveDuration The max duration of an incentive in seconds

(the startLeadTime and duration comments were mixed up; the rest of the changes are just to be consistent with the exact wording & capitalization in IUniswapV3Staker.sol)

@moodysalem moodysalem added the wontfix This will not be worked on label Jul 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants