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

Fix UPGRADE_INTERFACE_VERSION documentation in ProxyAdmin #5031

Merged
merged 2 commits into from
May 3, 2024

Conversation

ericglau
Copy link
Member

@ericglau ericglau commented May 2, 2024

The NatSpec documentation for UPGRADE_INTERFACE_VERSION in ProxyAdmin describes functions using the wrong number of arguments and a wrong function name. Notably, it is missing the first argument which is the address of the proxy.

This PR fixes the documented references to upgrade and upgradeAndCall.

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

Copy link

changeset-bot bot commented May 2, 2024

🦋 Changeset detected

Latest commit: e089c4d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
openzeppelin-solidity Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@ericglau ericglau requested a review from a team May 2, 2024 19:00
@Amxx Amxx merged commit 52c36d4 into OpenZeppelin:master May 3, 2024
20 checks passed
Copy link

gitpoap-bot bot commented May 3, 2024

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 OpenZeppelin Contracts Contributor:

GitPOAP: 2024 OpenZeppelin Contracts Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

@ericglau ericglau deleted the proxyadmin branch May 3, 2024 13:28
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

Successfully merging this pull request may close these issues.

2 participants