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

Grammar and Clarity Improvements #900

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

Conversation

donatik27
Copy link

Changes Made

In README.md:

Original: "The arkworks ecosystem consist of Rust libraries"
New: "The arkworks ecosystem consists of Rust libraries"
Reason: Fixed subject-verb agreement - "ecosystem" is singular and requires "consists"

In ec/README.md:

Original: "We can convert it the AffineRepr representation"
New: "We can convert it to the AffineRepr representation"
Reason: Added missing preposition "to" for grammatical correctness

Why These Changes Matter

  1. Proper grammar and clear writing are important for:

    • Making documentation more professional
    • Improving readability for non-native English speakers
    • Reducing potential confusion or misunderstandings
    • Maintaining high code quality standards
  2. These specific fixes:

    • Correct basic grammatical errors
    • Make the technical documentation more precise
    • Improve the overall quality of the project documentation

Testing

No code changes were made, only documentation updates. No testing required.

Checklist

  • Documentation updates only
  • No code changes
  • No breaking changes
  • Improves readability

@donatik27 donatik27 requested review from a team as code owners November 29, 2024 13:05
@donatik27 donatik27 requested review from mmagician, weikengchen and tyshko-rostyslav and removed request for a team November 29, 2024 13:05
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.

1 participant