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

feat(forge doc): include @custom NatSpec #8488

Closed
Tracked by #4115
Metaxona opened this issue Jul 21, 2024 · 2 comments · Fixed by #9075
Closed
Tracked by #4115

feat(forge doc): include @custom NatSpec #8488

Metaxona opened this issue Jul 21, 2024 · 2 comments · Fixed by #9075
Assignees
@leovct
Labels
C-forge Command: forge Cmd-forge-doc Command: forge doc first issue A good way to start contributing T-feature Type: feature

Comments

@Metaxona
Copy link

Metaxona commented Jul 21, 2024 •
edited by zerosnacks
Loading

Component

Forge

Describe the feature you would like

it's weird to have author and all other natspec @ without including the @custom one

i think it would be good to have it on the same level as @author or 1 level below

this should be included in the generated docs

Additional context

No response
@Metaxona Metaxona added the T-feature Type: feature label Jul 21, 2024
@zerosnacks zerosnacks changed the title Forge Doc Include @custom NatSpec feat(forge doc): include @custom NatSpec Jul 22, 2024
@zerosnacks zerosnacks added C-forge Command: forge Cmd-forge-doc Command: forge doc labels Jul 22, 2024
@zerosnacks zerosnacks mentioned this issue Jul 23, 2024
Open
4 tasks
@zerosnacks zerosnacks added this to the v1.0.0 milestone Jul 26, 2024
@jenpaff jenpaff added the first issue A good way to start contributing label Sep 26, 2024
@grandizzy grandizzy removed this from the v1.0.0 milestone Oct 1, 2024
@github-project-automation github-project-automation bot moved this to Todo in Foundry Oct 1, 2024
@leovct
Copy link
Contributor

leovct commented Oct 9, 2024

Hi @zerosnacks, I'd like to work on this issue :)

@zerosnacks
Copy link
Member

Thanks @leovct!

@leovct leovct mentioned this issue Oct 9, 2024
Merged
@github-project-automation github-project-automation bot moved this from Todo to Done in Foundry Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leovct leovct

Labels
C-forge Command: forge Cmd-forge-doc Command: forge doc first issue A good way to start contributing T-feature Type: feature
Projects
Foundry
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(forge doc): include custom natspec leovct/foundry
5 participants
@jenpaff @leovct @grandizzy @zerosnacks @Metaxona