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 minor grammatical errors in documentation #941

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

Conversation

famouswizard
Copy link

@famouswizard famouswizard commented Nov 23, 2024

Fix minor grammatical errors in documentation

Description

Two minor grammatical issues in the documentation files docs/src/fft/benchmarks.md and docs/src/plonk/implementation.md. These errors could cause confusion for readers and reduce the professionalism of the documentation.

  1. In docs/src/fft/benchmarks.md, the sentence:

    "Those cases which were greater than 30 seconds were marked respectively as they're too slow and weren't worth to be benchmarked."
    was corrected to:
    "Those cases which were greater than 30 seconds were marked respectively as they're too slow and weren't worth benchmarking."
    Explanation: The phrase "weren't worth to be benchmarked" is grammatically incorrect. The correct phrase is "weren't worth benchmarking," which improves the readability and clarity of the sentence.

  2. In docs/src/plonk/implementation.md, the sentence:

    "Let's brake it down."
    was corrected to:
    "Let's break it down."
    Explanation: The word "brake" was mistakenly used instead of "break." "Brake" refers to a stopping mechanism, while "break" is the correct word in this context, meaning to divide or analyze something in parts.

These changes improve the clarity and professionalism of the documentation.

Type of change

Please delete options that are not relevant.

  • Optimization

Checklist

  • Documentation has been added/updated.

@famouswizard famouswizard requested a review from a team as a code owner November 23, 2024 09:44
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