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 comments for clarity and grammatical correctness #1320

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

defitricks
Copy link
Contributor

Changes:

  1. In frontend/builder.go:

    • Fixed the grammatical error in the comment for the MarkBoolean method. The original comment was:

      "MarkBoolean sets (but do not constraint!) v to be boolean"

    • Corrected to:

      "MarkBoolean sets (but does not constrain!) v to be boolean"

    • Explanation: The word "constraint" was used incorrectly. The verb should be "constrain" as it follows the auxiliary verb "does" which requires the infinitive form.
  2. In frontend/variable.go:

    • Fixed the plural form of "builder" in the comment for the IsCanonical function. The original comment was:

      "by one of the constraint system builder."

    • Corrected to:

      "by one of the constraint system builders."

    • Explanation: The sentence refers to multiple potential builders, so the correct form is "builders" (plural).

These changes improve the grammatical accuracy and clarity of the comments, ensuring the documentation aligns with standard English usage.

  • Bug fix (non-breaking change which fixes an issue)

The typo is in the description of the MarkBoolean method
In the comment for the IsCanonical function
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@ivokub ivokub changed the base branch from master to fix/typos-v0.12 November 22, 2024 12:24
@ivokub ivokub self-requested a review November 22, 2024 12:24
Copy link
Collaborator

@ivokub ivokub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution! I'll merge it to the fix/typos-v0.12 branch for now which will be merged before the next release (either 0.11.1 or 0.12). There are some other PRs open and we'd like to avoid individual merge conflicts.

@ivokub ivokub merged commit 296c74c into Consensys:fix/typos-v0.12 Nov 22, 2024
lucasmenendez pushed a commit to lucasmenendez/gnark that referenced this pull request Jan 31, 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.

3 participants