You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The API docs for Contracts need some changes to make it clear that they are also the API docs for Contracts Upgradeable.
It's only two things that are different: the contract names (that have an added suffix), and the initializer functions.
For initializer functions we could edit the title of the constructor entry so that it also appears as the entry for the initializer function. (This can be easily implemented using the docgen template.) A mockup:
We need to figure out how to include this information without making noise for users who are only interested in the non-upgradeable variant of Contracts or vice versa.
The text was updated successfully, but these errors were encountered:
Well everything is the same except for the constructor so I don't think we need to duplicate. Just make sure the normal API docs are also usable when using the upgradeable version.
frangio
changed the title
Consider showing initializer function names in Contracts API docs
Make it explicit and clear that Contracts API docs apply to Contracts Upgradeable as well
Dec 1, 2020
frangio
changed the title
Make it explicit and clear that Contracts API docs apply to Contracts Upgradeable as well
Improve Contracts API docs to function as Upgradeable docs too
Dec 1, 2020
The API docs for Contracts need some changes to make it clear that they are also the API docs for Contracts Upgradeable.
It's only two things that are different: the contract names (that have an added suffix), and the initializer functions.
For initializer functions we could edit the title of the constructor entry so that it also appears as the entry for the initializer function. (This can be easily implemented using the docgen template.) A mockup:
We need to figure out how to include this information without making noise for users who are only interested in the non-upgradeable variant of Contracts or vice versa.
The text was updated successfully, but these errors were encountered: