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 Style Improvements #41

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

Conversation

donatik27
Copy link

Changes

In docs/zktrie.md:

  1. "nodes with same prefix" → "nodes with the same prefix"
    • Added missing article "the" for grammatical correctness
  2. "showed below" → "shown below"
    • Corrected to proper past participle form

In types/README.md:

  1. "data node being stored" → "data nodes being stored"
    • Fixed singular/plural agreement
  2. "Can be decompose" → "Can be decomposed"
    • Corrected to proper past participle form
  3. "as following" → "as follows"
    • Fixed to proper idiomatic expression

Rationale

These changes improve the documentation by:

  • Ensuring proper grammar and consistent style
  • Using correct verb forms and tenses
  • Adding missing articles where grammatically required
  • Making technical documentation more professional and easier to read

The modifications maintain the technical accuracy while enhancing readability and adherence to English language conventions.

Files Modified

  • docs/zktrie.md
  • types/README.md

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