chore: Update ACIR documentation#3919
Closed
joaolago1113 wants to merge 1 commit intonoir-lang:masterfrom
joaolago1113:update
Closed
chore: Update ACIR documentation#3919joaolago1113 wants to merge 1 commit intonoir-lang:masterfrom joaolago1113:update
joaolago1113 wants to merge 1 commit intonoir-lang:masterfrom
joaolago1113:update
Conversation
5 tasks
Member
|
Hi. We've recently decided on a policy that we will not be merging typo fix PRs unless someone has done a significant contribution already. The recent usage of Github commits as a metric mean we have to manage this a bit. We will redo this change and thank you for the contribution. |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 3, 2024
# Description ## Problem\* Resolves <!-- Link to GitHub Issue --> ## Summary\* Replay of #3919 PR ## Additional Context ## Documentation\* Check one: - [ ] No documentation needed. - [x] Documentation included in this PR. - [ ] **[Exceptional Case]** Documentation to be submitted in a separate PR. # PR Checklist\* - [x] I have tested the changes locally. - [x] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While solving the Discover Noir quests in nodeguardians (pretty cool way to learn by the way), I stumbled upon a few grammatical hiccups in the docs. So I thought it'd be helpful to smooth these out for anyone else who's on this learning journey.
Here's a quick rundown of the changes I made:
In
acir_docs.md, tweaked a couple of sentences for clarity. For instance, changed "abstract here simply mean" to "abstract here simply means", and "proving system need" to "proving system needs".In
installation/index.md, fixed a typo: changed "though" to "through".In various testing docs like
testing.md, I corrected phrases like "satisfying the all" to "satisfying all".In
migration_notes.md, cleaned up a few words – for example, "filed" to "file" and "you" to "your".In
logging.md, sorted out the word "constrains", changing it to "constraints".