hardhat-vscode icon indicating copy to clipboard operation
hardhat-vscode copied to clipboard

Feature Request: Show a function's documentation reference when a dev clicks a function's `@inheritdoc` tag

Open scorpion9979 opened this issue 2 years ago • 3 comments

I noticed that the extension currently has no support for the @inheritdoc tag, and I think it would be a very useful feature to be able to display an overridden function's interface documentation in the VSCode references.

image

image Note: code above is from hifi-finance/hifi.

scorpion9979 avatar Mar 22 '22 15:03 scorpion9979

This issue is also being tracked on Linear.

We use Linear to manage our development process, but we keep the conversations on Github.

LINEAR-ID: d8ae6723-09f2-4766-b832-3f4d40134b57

github-actions[bot] avatar Mar 22 '22 15:03 github-actions[bot]

Hey @scorpion9979, just to clarify is the idea here that the inheritdoc would become a link of some sort, or that we swap in the documentation inline?

kanej avatar Mar 25 '22 09:03 kanej

Hey @scorpion9979, just to clarify is the idea here that the inheritdoc would become a link of some sort, or that we swap in the documentation inline?

Yes, the first part is closer to what I have in mind. I think it would be cool to make the inheritdoc tag link to the smart contract's inline documentation of that particular function.

scorpion9979 avatar Mar 25 '22 14:03 scorpion9979