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

natspec does not show inheritance #109

Open
lnist opened this issue Dec 21, 2022 · 1 comment
Open

natspec does not show inheritance #109

lnist opened this issue Dec 21, 2022 · 1 comment

Comments

@lnist
Copy link
Contributor

lnist commented Dec 21, 2022

For instance MangroveOrder inherits from Forwarder: contract MangroveOrder is Forwarder, IOrderLogic

It may be an issue with the plugin we are using, the template embedded in the plugin, or simply not supported.

Maybe this will help when it is completed: foundry-rs/foundry#1675 (e.g., through this PR: foundry-rs/foundry#2701 )

@sync-by-unito sync-by-unito bot closed this as completed Feb 11, 2023
@espendk espendk reopened this Feb 13, 2023
@lnist
Copy link
Contributor Author

lnist commented Jan 12, 2024

forge docs does show inheritance, so it is a good candidate. However it is quite new and plugs directly to an mdbook serving, so currently paths will not work when embedded inside docusaurus (we could do some search and replacing). It also places links to github can be wrong (foundry-rs/foundry#5711) especially in our case where doc is currently generated from docs repo (the links end up being to docs repo) (this could also be fixed with search and replace).
It also messes up whitespace: foundry-rs/foundry#5096

So leaving as is for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants