Skip to content

Standardise inheriting NatSpec from the interface contract #25

@parv3213

Description

@parv3213

Currently, only a few of our functions have their definitions in their interface, resulting in only their NatSpec documentation being inherited from the interface. To align with best practices, we should update all our interfaces to include all external and public functions along with their NatSpec documentation.

For example, in this repository (https://github.com/Uniswap/v3-core/blob/main/contracts/UniswapV3Pool.sol), documentation for all external and public functions is inherited from its interface. Additionally, if you observe, the interface even defines the public variables.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions