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

Consistent NatSpec comments #575

Open
cam-schultz opened this issue Sep 26, 2024 · 0 comments
Open

Consistent NatSpec comments #575

cam-schultz opened this issue Sep 26, 2024 · 0 comments
Labels

Comments

@cam-schultz
Copy link
Contributor

Context and scope
We should be consitent and rigorous in our use of NatSpec documentation comments: https://docs.soliditylang.org/en/latest/natspec-format.html

Discussion and alternatives
What follows is a non-exhaustive style guide that should be adhered to:

  • Interface function declarations should specify function behavior and all inputs and outputs
  • The same applies to top-level function definitions in an inheritance hierarchy
  • Implementations of interfaces and overrides should include a reference to the top-level declaration, e.g. @dev See {ITeleporterMessenger-sendCrossChainMessage}
@cam-schultz cam-schultz added the enhancement New feature or request label Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Backlog 🗄️
Development

No branches or pull requests

2 participants