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.

Sign up for GitHub

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

Jump to bottom

Improve EVM contract natspec docs #3477

Open
tonyjin opened this issue Oct 30, 2023 · 4 comments
Open

Improve EVM contract natspec docs #3477

tonyjin opened this issue Oct 30, 2023 · 4 comments
Labels
good first issue Good for newcomers

Comments

@tonyjin
Copy link

tonyjin commented Oct 30, 2023

Description and context

Go through core EVM contracts and improve natspec documentation for public functions.

Definition of done

Docs are in a state where forge doc can auto-generate documents we'd be comfortable putting on docs.wormhole.com.
@tonyjin tonyjin added the good first issue Good for newcomers label Oct 30, 2023
@fahimahmedx
Copy link

I'll take this on!

@fahimahmedx fahimahmedx mentioned this issue Nov 2, 2023
Closed
@fahimahmedx
Copy link

Added NatSpec documentation to many (but not all) of the solidity files in PR #3489.
Let me know what you think!
Additionally, am I supposed to include the result of forge doc in the PR? It adds ~348 files which seemed spammy.

@HemaDeviU
Copy link

If this isn't closed yet, can I work on it?

@Narendra-Reddy1
Copy link

@tonyjin I'm taking up this issue.
please assign it to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@tonyjin @Narendra-Reddy1 @fahimahmedx @HemaDeviU and others