Skip to content

chore: Update ACIR documentation#3919

Closed
joaolago1113 wants to merge 1 commit intonoir-lang:masterfrom
joaolago1113:update
Closed

chore: Update ACIR documentation#3919
joaolago1113 wants to merge 1 commit intonoir-lang:masterfrom
joaolago1113:update

Conversation

@joaolago1113
Copy link
Contributor

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:

  1. 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".

  2. In installation/index.md, fixed a typo: changed "though" to "through".

  3. In various testing docs like testing.md, I corrected phrases like "satisfying the all" to "satisfying all".

  4. In migration_notes.md, cleaned up a few words – for example, "filed" to "file" and "you" to "your".

  5. In logging.md, sorted out the word "constrains", changing it to "constraints".

@TomAFrench
Copy link
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.

@TomAFrench TomAFrench closed this Jan 2, 2024
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.
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