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 the "utilities" documentation page #4678

Merged
merged 5 commits into from
Oct 12, 2023

Conversation

Amxx
Copy link
Collaborator

@Amxx Amxx commented Oct 12, 2023

Fixes #4673

This should be cherrypicked on top of the docs branch.

PR Checklist

  • Documentation

@Amxx Amxx added this to the post 5.0 milestone Oct 12, 2023
@Amxx Amxx requested a review from ernestognw October 12, 2023 09:35
@changeset-bot
Copy link

changeset-bot bot commented Oct 12, 2023

⚠️ No Changeset found

Latest commit: d3bd843

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
Copy link
Member

I think we need to remove all the Payments section altogether, it's empty now!
Similarly, we're referencing SafeMath a couple of lines above

@Amxx
Copy link
Collaborator Author

Amxx commented Oct 12, 2023

The rest of the "Payments" option is not related to our utils, but its still usefull information. Maybe we should move it to the "Address" part ?

@Amxx Amxx changed the title Remove reference to PaymentSplitter in Documentation Update the "utilities" documentation page Oct 12, 2023
@ernestognw
Copy link
Member

I readded the Math section describing what's featuring there. Regarding the "Payments" not, I just checked in Address and we're already very clear about reentrancies. I think that section served as an introduction before but now it doesn't make sense to keep it imo.

@Amxx Amxx enabled auto-merge (squash) October 12, 2023 17:04
@Amxx Amxx disabled auto-merge October 12, 2023 17:08
@Amxx Amxx merged commit b48d658 into OpenZeppelin:master Oct 12, 2023
14 checks passed
@Amxx Amxx deleted the docs/fix-links branch October 12, 2023 17:08
ernestognw added a commit that referenced this pull request Oct 12, 2023
Co-authored-by: ernestognw <ernestognw@gmail.com>
Amxx added a commit to Amxx/openzeppelin-contracts that referenced this pull request Oct 12, 2023
Co-authored-by: ernestognw <ernestognw@gmail.com>
(cherry picked from commit b48d658)
Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
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.

Documentation links to non-existing contract
2 participants