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 _revokeRole documentation in AccessControl #5321

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Madmaxs2
Copy link

Changes Overview

1. contracts/access/AccessControl.sol

- @dev Attempts to revoke `role` to `account`
+ @dev Attempts to revoke `role` from `account`

Reason: The preposition "to" is incorrect with the verb "revoke". The proper grammatical construction is "revoke from" when indicating the source from which something is being taken away.

2. audits/2017-03.md

- warrantees
+ warranties

Reason: "Warrantees" is a misspelling. "Warranties" is the correct plural form of "warranty" when referring to guarantees or promises about a product or service.

3. audits/2017-03.md

- recomment
+ recommend

Reason: "Recomment" is a typographical error. "Recommend" is the correct spelling of the verb meaning to suggest or advise.

Summary

These changes improve the documentation by:

  • Correcting grammatical structure in function documentation
  • Fixing spelling errors in audit documentation
  • Maintaining consistency in technical terminology

The modifications enhance readability and professionalism of the codebase while ensuring accurate technical communication.

Testing

No functional changes were made; these are documentation-only updates.

Additional Notes

All changes are focused on improving clarity and correctness of the documentation without altering any functional code.

Copy link

changeset-bot bot commented Nov 26, 2024

⚠️ No Changeset found

Latest commit: a3579a7

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

ernestognw
ernestognw previously approved these changes Nov 26, 2024
@ernestognw
Copy link
Member

Thanks @Madmaxs2, we'll need 2 reviews here.

@ernestognw ernestognw requested a review from a team November 26, 2024 15:34
@ernestognw
Copy link
Member

Some feedback from the team is that we consider changing the audit files a bit controversial. We don't think is worth discussing it much while the contribution can still go through with the AccessControl update.

@ernestognw ernestognw changed the title Fix Grammar and Spelling Issues in Documentation Update _revokeRole documentation in AccessControl Nov 26, 2024
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.

4 participants