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

bug(forge doc): @inheritdoc doesn't work if package is coming from another repo #9328

Open
2 tasks done
novaknole opened this issue Nov 15, 2024 · 2 comments
Open
2 tasks done

bug(forge doc): @inheritdoc doesn't work if package is coming from another repo #9328

novaknole opened this issue Nov 15, 2024 · 2 comments
Labels
C-forge Command: forge Cmd-forge-doc Command: forge doc T-bug Type: bug T-to-reproduce Type: requires reproduction

Comments

@novaknole
Copy link

Component

Forge

Have you ensured that all of these are up to date?

  • Foundry
  • Foundryup

What version of Foundry are you on?

forge 0.2.0 (f479e94 2024-06-01T00:19:17.421178000Z)

What command(s) is the bug in?

forge doc

Operating System

macOS (Intel)

Describe the bug

If @inheritdoc is used for the contract that is in another repo/package(not the main repo), descriptions don't end up in the documentation, but if @inheritdoc is used for the contract that is inside the main repo, then it works fine.

Seems like a bug, but not sure fully.
@novaknole novaknole added T-bug Type: bug T-needs-triage Type: this issue needs to be labelled labels Nov 15, 2024
@github-project-automation github-project-automation bot moved this to Todo in Foundry Nov 15, 2024
@grandizzy
Copy link
Collaborator

hi @novaknole please provide a minimal repro to understand better the use case. thank you.

@zerosnacks zerosnacks added the T-to-reproduce Type: requires reproduction label Nov 15, 2024
@zerosnacks zerosnacks changed the title @inheritdoc doesn't work if package is coming from another repo bug(forge doc): @inheritdoc doesn't work if package is coming from another repo Nov 15, 2024
@zerosnacks zerosnacks added C-forge Command: forge Cmd-forge-doc Command: forge doc and removed T-needs-triage Type: this issue needs to be labelled labels Nov 15, 2024
@grandizzy
Copy link
Collaborator

Bump @novaknole could you pls provide a repro? Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-forge Command: forge Cmd-forge-doc Command: forge doc T-bug Type: bug T-to-reproduce Type: requires reproduction
Projects
Foundry
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
3 participants
@novaknole @grandizzy @zerosnacks