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.

Sign up for GitHub

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

Jump to bottom

Improve ERC-1363 documentation #4854

Merged
merged 3 commits into from
Jan 24, 2024
Merged

Improve ERC-1363 documentation #4854

merged 3 commits into from
Jan 24, 2024

Conversation

Amxx
Copy link
Collaborator

@Amxx Amxx commented Jan 24, 2024

Fixes #4631 (comment)

PR Checklist

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

@Amxx Amxx added documentation Inline comments, guides, and examples. ignore-changeset labels Jan 24, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 24, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: e84333f

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

@vittominacori
Copy link
Contributor

Also _checkOnTransferReceived and _checkOnApprovalReceived have the documentation issue.

vittominacori
vittominacori reviewed Jan 24, 2024
View reviewed changes
Copy link
Contributor

@vittominacori vittominacori left a comment

Choose a reason for hiding this comment

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

The param name is wrong there, anyway I will keep the requirements section only on the _check* methods or only in the high level ones to avoid duplications.

contracts/token/ERC20/extensions/ERC1363.sol Outdated Show resolved Hide resolved
contracts/token/ERC20/extensions/ERC1363.sol Outdated Show resolved Hide resolved
@ernestognw @vittominacori
Apply suggestions from code review
e84333f 
Co-authored-by: Vittorio Minacori <vittoriominacori@gmail.com>
ernestognw
ernestognw approved these changes Jan 24, 2024
View reviewed changes
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 for pointing out @vittominacori!

@Amxx Amxx merged commit b5a7f97 into OpenZeppelin:master Jan 24, 2024
19 checks passed
@Amxx Amxx deleted the doc/fix-erc-1363 branch January 24, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vittominacori vittominacori vittominacori left review comments

@ernestognw ernestognw ernestognw approved these changes

Assignees
No one assigned
Labels
documentation Inline comments, guides, and examples. ignore-changeset
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Amxx @vittominacori @ernestognw