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

Improve Contracts API docs to function as Upgradeable docs too #105

Open
frangio opened this issue Nov 24, 2020 · 2 comments
Open

Improve Contracts API docs to function as Upgradeable docs too #105

frangio opened this issue Nov 24, 2020 · 2 comments
Labels

Comments

@frangio
Copy link
Contributor

frangio commented Nov 24, 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:

image

image

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.

@abcoathup
Copy link
Contributor

We could have the Upgradeable version after each contract (perhaps minimized)?
Alternatively we have an API Upgradeable section?

@frangio
Copy link
Contributor Author

frangio commented Nov 26, 2020

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 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 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
@frangio frangio added the docs label Dec 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants