search

foundry-rs / foundry

Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
https://getfoundry.sh
Apache License 2.0
8.31k stars 1.75k forks source link

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

Open novaknole opened 3 hours ago

novaknole commented 3 hours ago

Component

Forge

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

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.

grandizzy commented 2 hours ago

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