-
Notifications
You must be signed in to change notification settings - Fork 112
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
Base documentation off of compiled interface, not IContract file #1306
Conversation
The main decision I've taken that I could have gone the other way on is how I've handled The alternative, I think, would be to move (most of) our |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📚
Closes #1272.
Primarily this is a slight rework of the
docgen.js
script. Instead of just using the interface file for a contract to work out which functions should be in the docs, it uses the ABI and a flattened version of the source to generate the documentation of every function that is actually on the contracts. In the event of a function being documented in multiple places, it picks the documentation that is the longest.To get this to work cleanly, I've ended up introducing e.g.
BasicMetaTransaction is IBasicMetaTransaction
and equivalents in various places, which seems like something we should have been doing anyway to ensure consistency.NB Currently based on #1305