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

Standardise inheriting NatSpec from the interface contract #25

Open
parv3213 opened this issue Oct 11, 2023 · 0 comments
Open

Standardise inheriting NatSpec from the interface contract #25

parv3213 opened this issue Oct 11, 2023 · 0 comments

Comments

@parv3213
Copy link
Member

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.

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

No branches or pull requests

1 participant