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

Fix typos in documentation and code comments #1815

Closed
wants to merge 5 commits into from

Conversation

Dimitrolito
Copy link

This pull request addresses several typographical errors and improves the clarity of documentation and code comments throughout various files. Below is a summary of the changes made:

  1. Fixed hyphenation in the phrase "up-to-date" in the CONTRIBUTING.md file.
  2. Corrected "end-to-end" spelling in recommended-workflow.md for better readability.
  3. Replaced "todos" with "to-dos" in recommended-workflow.md, following the proper grammatical rule for compound nouns.
  4. Fixed missing article issue in the phrase "a field elements" in SP1VerifierGroth16.txt and SP1VerifierPlonk.txt.
  5. Fixed the use of "emit events" to "to emit events" in CHANGELOG.md.
  6. Corrected the plural noun usage in SP1Verifier contract comments from "field elements" to properly reflect grammar.

Motivation:

The changes aim to improve the clarity and correctness of the documentation and comments. These minor fixes contribute to maintaining consistency and readability across the codebase.

Solution:

  • Fixed common typos and added missing hyphens in compound adjectives.
  • Ensured proper grammatical structure in the documentation and code comments.

PR Checklist:

  • Added Tests
  • Added Documentation
  • Breaking changes

@puma314 puma314 closed this Dec 1, 2024
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