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

fix(forge doc): display custom natspec tag #9257

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

leovct
Copy link
Contributor

@leovct leovct commented Nov 4, 2024

Motivation

Display custom natspec tag when generating documentation with forge doc.

Solution

Custom natspec comments are now preceded by their tag.

Screenshot 2024-11-04 at 10 10 34

@leovct leovct marked this pull request as ready for review November 4, 2024 09:20
Copy link
Member

@zerosnacks zerosnacks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @leovct!

@zerosnacks zerosnacks merged commit 32f8e79 into foundry-rs:master Nov 4, 2024
21 checks passed
@leovct leovct deleted the fix/forge-doc-custom-natspec branch November 4, 2024 09:48
leovct added a commit to leovct/foundry that referenced this pull request Nov 6, 2024
fix(forge doc): display custom natspec tag
rplusq pushed a commit to rplusq/foundry that referenced this pull request Nov 29, 2024
fix(forge doc): display custom natspec tag
@grandizzy grandizzy added T-bug Type: bug C-forge Command: forge labels Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-forge Command: forge T-bug Type: bug
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants