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 inline documentation for errors/events #480

Open
djb15 opened this issue Jul 22, 2024 · 0 comments
Open

Standardise inline documentation for errors/events #480

djb15 opened this issue Jul 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation evm Change to EVM Contracts

Comments

@djb15
Copy link
Collaborator

djb15 commented Jul 22, 2024

The inline documentation for newer events/errors is sometimes inconsistent with older ones. Older events had input descriptors with function selectors/topic0 listed, but some newer ones lack either the selector or parameter description, or both. For example, error UnexpectedDeployer(address expectedOwner, address owner); lacks a selector/parameter description. The same issue exists for InvalidPeerInvalidPeerChainIdZero, and InvalidPeerZeroAddress. It would be great if we could standardize everything.

@djb15 djb15 added documentation Improvements or additions to documentation evm Change to EVM Contracts labels Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation evm Change to EVM Contracts
Projects
None yet
Development

No branches or pull requests

1 participant