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

Update comment to reflect code logic in Ownable.sol #4369

Merged
merged 2 commits into from
Jun 22, 2023

Conversation

s-tikhomirov
Copy link
Contributor

The initial owner is not automatically assigned to the deployer's address. Rather, the initial owner is set to the constructor argument provided by the deployer.

(The code was modified in commit 13d5e04 but the comment wasn't.)

Fixes #????

PR Checklist

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

The initial owner is not automatically assigned to the deployer's address. Rather, the initial owner is set to the constructor argument provided by the deployer.

(The code was modified in commit 13d5e04 but the comment wasn't.)
@changeset-bot
Copy link

changeset-bot bot commented Jun 18, 2023

⚠️ No Changeset found

Latest commit: c450ec7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Member

@ernestognw ernestognw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @s-tikhomirov, Github doesn't allow suggestions 3 lines further than the change, but I think we should also update the NatSpec on top of the contract itself where it reads:

By default, the owner account will be the one that deploys the contract.

We've already received comments about this inaccuracy, so just flagging it before merging.

Fix NatSpec comment regarding the initial owner
Copy link
Member

@ernestognw ernestognw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @s-tikhomirov!

@ernestognw ernestognw merged commit a7a94c7 into OpenZeppelin:master Jun 22, 2023
@gitpoap-bot
Copy link

gitpoap-bot bot commented Jun 22, 2023

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

GitPOAP: 2023 OpenZeppelin Contracts Contributor:

GitPOAP: 2023 OpenZeppelin Contracts Contributor GitPOAP Badge

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

Learn more about GitPOAPs here.

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

Successfully merging this pull request may close these issues.

Ownable's NatSpec incorrectly describes the mechanism for setting the initial owner
3 participants