Skip to content

Docs: Improve grammar, consistency, and clarity in ERC-20, ERC-1155, and Backwards Compatibility guides#5599

Closed
Pronoss wants to merge 4 commits intoOpenZeppelin:masterfrom
Pronoss:fix/update
Closed

Docs: Improve grammar, consistency, and clarity in ERC-20, ERC-1155, and Backwards Compatibility guides#5599
Pronoss wants to merge 4 commits intoOpenZeppelin:masterfrom
Pronoss:fix/update

Conversation

@Pronoss
Copy link
Contributor

@Pronoss Pronoss commented Mar 21, 2025

This PR improves the clarity, grammar, and consistency of the following documentation files:

  • backwards-compatibility.adoc
  • erc1155.adoc
  • erc20-supply.adoc
  • erc20.adoc

Key Improvements:

  • Fixed grammar (e.g., added missing commas, corrected "whilst" to "while")
  • Standardized phrasing (e.g., "OpenZeppelin Contracts provide" instead of "provides" where appropriate)
  • Improved clarity in complex sentences for better readability
  • Reworded misleading or ambiguous statements without altering technical meaning
  • Formatted large numbers with commas for better readability (e.g., 350k → 350,000)
  • Consistent usage of Oxford commas where needed

These changes help ensure the documentation is more accessible, clear, and consistent for users.

@ernestognw ernestognw closed this Mar 24, 2025
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

Comments