Skip to content

Commit

Permalink
chore(docs): fix spelling issues in docs (#3887)
Browse files Browse the repository at this point in the history
# Description

## Problem\*

Resolves <!-- Link to GitHub Issue -->

## Summary\*

I heard there's airdrops for typo fixes now so I've addressed all of the
typos in the docs. On an unrelated note this will prevent #3886 from
causing issues from existing spelling errors.

## 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.
  • Loading branch information
TomAFrench authored Dec 20, 2023
1 parent a3dfca8 commit 194939c
Show file tree
Hide file tree
Showing 99 changed files with 198 additions and 178 deletions.
8 changes: 4 additions & 4 deletions acvm-repo/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -977,7 +977,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* require `Backend` to implement `Default` trait ([#223](https://github.com/noir-lang/acvm/issues/223))
* Make GeneralOptimizer crate visible ([#220](https://github.com/noir-lang/acvm/issues/220))
* return `PartialWitnessGeneratorStatus` from `PartialWitnessGenerator.solve` ([#213](https://github.com/noir-lang/acvm/issues/213))
* organise operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190))
* organize operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190))

### Features

Expand All @@ -1000,7 +1000,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Miscellaneous Chores

* Make GeneralOptimizer crate visible ([#220](https://github.com/noir-lang/acvm/issues/220)) ([64bb346](https://github.com/noir-lang/acvm/commit/64bb346524428a0ce196826ea1e5ccde08ad6201))
* organise operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190)) ([a619df6](https://github.com/noir-lang/acvm/commit/a619df614bbb9b2518b788b42a7553b069823a0f))
* organize operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190)) ([a619df6](https://github.com/noir-lang/acvm/commit/a619df614bbb9b2518b788b42a7553b069823a0f))

## [0.9.0](https://github.com/noir-lang/acvm/compare/root-v0.8.1...root-v0.9.0) (2023-04-07)

Expand Down Expand Up @@ -1114,7 +1114,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* **acir:** make PublicInputs use a BTreeSet rather than Vec ([#99](https://github.com/noir-lang/acvm/issues/99))
* refactor ToRadix to ToRadixLe and ToRadixBe ([#58](https://github.com/noir-lang/acvm/issues/58))
* **acir:** Add keccak256 Opcode ([#91](https://github.com/noir-lang/acvm/issues/91))
* reorganise compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88))
* reorganize compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88))

### Features

Expand All @@ -1138,7 +1138,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Miscellaneous Chores

* refactor ToRadix to ToRadixLe and ToRadixBe ([#58](https://github.com/noir-lang/acvm/issues/58)) ([2427a27](https://github.com/noir-lang/acvm/commit/2427a275048e598c6d651cce8348a4c55148f235))
* reorganise compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88)) ([9329307](https://github.com/noir-lang/acvm/commit/9329307e054de202cfc55207162ad952b70d515e))
* reorganize compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88)) ([9329307](https://github.com/noir-lang/acvm/commit/9329307e054de202cfc55207162ad952b70d515e))

## [0.4.1] - 2023-02-08

Expand Down
8 changes: 4 additions & 4 deletions acvm-repo/acir/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@

* replace `MerkleMembership` opcode with `ComputeMerkleRoot` ([#233](https://github.com/noir-lang/acvm/issues/233))
* return `PartialWitnessGeneratorStatus` from `PartialWitnessGenerator.solve` ([#213](https://github.com/noir-lang/acvm/issues/213))
* organise operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190))
* organize operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190))

### Features

Expand All @@ -415,7 +415,7 @@

### Miscellaneous Chores

* organise operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190)) ([a619df6](https://github.com/noir-lang/acvm/commit/a619df614bbb9b2518b788b42a7553b069823a0f))
* organize operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190)) ([a619df6](https://github.com/noir-lang/acvm/commit/a619df614bbb9b2518b788b42a7553b069823a0f))

## [0.9.0](https://github.com/noir-lang/acvm/compare/acir-v0.8.1...acir-v0.9.0) (2023-04-07)

Expand Down Expand Up @@ -507,7 +507,7 @@
* **acir:** make PublicInputs use a BTreeSet rather than Vec ([#99](https://github.com/noir-lang/acvm/issues/99))
* refactor ToRadix to ToRadixLe and ToRadixBe ([#58](https://github.com/noir-lang/acvm/issues/58))
* **acir:** Add keccak256 Opcode ([#91](https://github.com/noir-lang/acvm/issues/91))
* reorganise compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88))
* reorganize compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88))

### Features

Expand All @@ -518,4 +518,4 @@
### Miscellaneous Chores

* refactor ToRadix to ToRadixLe and ToRadixBe ([#58](https://github.com/noir-lang/acvm/issues/58)) ([2427a27](https://github.com/noir-lang/acvm/commit/2427a275048e598c6d651cce8348a4c55148f235))
* reorganise compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88)) ([9329307](https://github.com/noir-lang/acvm/commit/9329307e054de202cfc55207162ad952b70d515e))
* reorganize compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88)) ([9329307](https://github.com/noir-lang/acvm/commit/9329307e054de202cfc55207162ad952b70d515e))
8 changes: 4 additions & 4 deletions acvm-repo/acvm/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@
* require `Backend` to implement `Default` trait ([#223](https://github.com/noir-lang/acvm/issues/223))
* Make GeneralOptimizer crate visible ([#220](https://github.com/noir-lang/acvm/issues/220))
* return `PartialWitnessGeneratorStatus` from `PartialWitnessGenerator.solve` ([#213](https://github.com/noir-lang/acvm/issues/213))
* organise operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190))
* organize operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190))

### Features

Expand All @@ -557,7 +557,7 @@
### Miscellaneous Chores

* Make GeneralOptimizer crate visible ([#220](https://github.com/noir-lang/acvm/issues/220)) ([64bb346](https://github.com/noir-lang/acvm/commit/64bb346524428a0ce196826ea1e5ccde08ad6201))
* organise operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190)) ([a619df6](https://github.com/noir-lang/acvm/commit/a619df614bbb9b2518b788b42a7553b069823a0f))
* organize operator implementations for Expression ([#190](https://github.com/noir-lang/acvm/issues/190)) ([a619df6](https://github.com/noir-lang/acvm/commit/a619df614bbb9b2518b788b42a7553b069823a0f))

## [0.9.0](https://github.com/noir-lang/acvm/compare/acvm-v0.8.1...acvm-v0.9.0) (2023-04-07)

Expand Down Expand Up @@ -641,7 +641,7 @@
* update `ProofSystemCompiler` to not take ownership of keys ([#111](https://github.com/noir-lang/acvm/issues/111))
* update `ProofSystemCompiler` methods to take `&Circuit` ([#108](https://github.com/noir-lang/acvm/issues/108))
* refactor ToRadix to ToRadixLe and ToRadixBe ([#58](https://github.com/noir-lang/acvm/issues/58))
* reorganise compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88))
* reorganize compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88))

### Features

Expand All @@ -659,4 +659,4 @@
### Miscellaneous Chores

* refactor ToRadix to ToRadixLe and ToRadixBe ([#58](https://github.com/noir-lang/acvm/issues/58)) ([2427a27](https://github.com/noir-lang/acvm/commit/2427a275048e598c6d651cce8348a4c55148f235))
* reorganise compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88)) ([9329307](https://github.com/noir-lang/acvm/commit/9329307e054de202cfc55207162ad952b70d515e))
* reorganize compiler in terms of optimisers and transformers ([#88](https://github.com/noir-lang/acvm/issues/88)) ([9329307](https://github.com/noir-lang/acvm/commit/9329307e054de202cfc55207162ad952b70d515e))
22 changes: 21 additions & 1 deletion cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"acvm",
"aeiou",
"appender",
"Arbitrum",
"arithmetization",
"arity",
"arkworks",
Expand All @@ -15,21 +16,26 @@
"bindgen",
"bitand",
"blackbox",
"bridgekeeper",
"brillig",
"cachix",
"callsite",
"callsites",
"canonicalize",
"castable",
"Celo",
"chumsky",
"clippy",
"codegen",
"codegens",
"Codespaces",
"codespan",
"coeff",
"combinators",
"comptime",
"cpus",
"cranelift",
"curvegroup",
"deflatten",
"deflattened",
"deflattening",
Expand All @@ -40,12 +46,14 @@
"desugared",
"direnv",
"eddsa",
"Elligator",
"endianness",
"envrc",
"Flamegraph",
"flate",
"fmtstr",
"foldl",
"foos",
"forall",
"foralls",
"formatcp",
Expand All @@ -69,32 +77,39 @@
"jmpif",
"jmpifs",
"jmps",
"Jubjub",
"keccak",
"krate",
"lvalue",
"mathbb",
"merkle",
"metas",
"monomorphization",
"monomorphize",
"monomorphized",
"monomorphizer",
"monomorphizes",
"montcurve",
"nand",
"nargo",
"newtype",
"nightlies",
"nixpkgs",
"noirc",
"noirjs",
"noirup",
"nomicfoundation",
"pedersen",
"peekable",
"plonkc",
"PLONKish",
"pprof",
"preprocess",
"prettytable",
"println",
"printstd",
"pseudocode",
"pubkey",
"quantile",
"rustc",
"rustup",
Expand All @@ -112,6 +127,8 @@
"subexpression",
"subshell",
"subtyping",
"swcurve",
"tecurve",
"tempdir",
"tempfile",
"termcolor",
Expand All @@ -126,7 +143,10 @@
"unnormalized",
"unoptimized",
"urem",
"USERPROFILE",
"vecmap",
"wasi"
"wasi",
"Weierstraß",
"zshell"
]
}
2 changes: 1 addition & 1 deletion docs/docs/explainers/explainer-recursion.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ In such a situation, and assuming Alice is first, she would skip the first part

### Aggregating proofs

In some one-way interaction situations, recursiveness would allow for aggregation of simple proofs that don't need to be immediately verified on-chain or elsewhere.
In some one-way interaction situations, recursion would allow for aggregation of simple proofs that don't need to be immediately verified on-chain or elsewhere.

To give a practical example, a barman wouldn't need to verify a "proof-of-age" on-chain every time he serves alcohol to a customer. Instead, the architecture would comprise two circuits:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ Check if the installation was successful by running `nargo --version`. You shoul
### Option 3: Compile from Source

Due to the large number of native dependencies, Noir projects uses [Nix](https://nixos.org/) and [direnv](https://direnv.net/) to streamline the development experience. It helps mitigating ssues commonly associated with dependency management, such as conflicts between required package versions for different projects (often referred to as "dependency hell").
Due to the large number of native dependencies, Noir projects uses [Nix](https://nixos.org/) and [direnv](https://direnv.net/) to streamline the development experience. It helps mitigating issues commonly associated with dependency management, such as conflicts between required package versions for different projects (often referred to as "dependency hell").

Combined with direnv, which automatically sets or unsets environment variables based on the directory, it further simplifies the development process by seamlessly integrating with the developer's shell, facilitating an efficient and reliable workflow for managing and deploying Noir projects with multiple dependencies.
Combined with direnv, which automatically sets or clears environment variables based on the directory, it further simplifies the development process by seamlessly integrating with the developer's shell, facilitating an efficient and reliable workflow for managing and deploying Noir projects with multiple dependencies.

#### Setting up your environment

Expand Down Expand Up @@ -163,7 +163,7 @@ Advanced: If you aren't using direnv nor launching your editor within the subshe

### Option 4: WSL (for Windows)

The default backend for Noir (Barretenberg) doesn't provide Windows binaries at this time. For that reason, Noir cannot be installed nativerly. However, it is available by using Windows Subsystem for Linux (WSL).
The default backend for Noir (Barretenberg) doesn't provide Windows binaries at this time. For that reason, Noir cannot be installed natively. However, it is available by using Windows Subsystem for Linux (WSL).

Step 1: Follow the instructions [here](https://learn.microsoft.com/en-us/windows/wsl/install) to install and run WSL.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting_started/project_breakdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Example Nargo.toml:

```toml
[package]
name = "noirstarter"
name = "noir_starter"
type = "bin"
authors = ["Alice"]
compiler_version = "0.9.0"
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting_started/tooling/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ fn test_add() {
```

Running `nargo test` will test that the `test_add` function can be executed while satisfying the all
the contraints which allows you to test that add returns the expected values. Test functions can't
the constraints which allows you to test that add returns the expected values. Test functions can't
have any arguments currently.

### Test fail
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/how_to/how-to-recursion.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ For a full example on how recursive proofs work, please refer to the [noir-examp

In a common NoirJS app, you need to instantiate a backend with something like `const backend = new Backend(circuit)`. Then you feed it to the `noir_js` interface.

For recursiveness, this doesn't happen, and the only need for `noir_js` is only to `execute` a circuit and get its witness and return value. Everything else is not interfaced, so it needs to happen on the `backend` object.
For recursion, this doesn't happen, and the only need for `noir_js` is only to `execute` a circuit and get its witness and return value. Everything else is not interfaced, so it needs to happen on the `backend` object.

It is also recommended that you instantiate the backend with as many threads as possible, to allow for maximum concurrency:

Expand Down Expand Up @@ -159,7 +159,7 @@ const backends = {
main: new BarretenbergBackend(circuits.main),
recursive: new BarretenbergBackend(circuits.recursive)
}
const noirs = {
const noir_programs = {
main: new Noir(circuits.main, backends.main),
recursive: new Noir(circuits.recursive, backends.recursive)
}
Expand All @@ -169,7 +169,7 @@ This allows you to neatly call exactly the method you want without conflicting n

```js
// Alice runs this 👇
const { witness: mainWitness } = await noirs.main.execute(input)
const { witness: mainWitness } = await noir_programs.main.execute(input)
const proof = await backends.main.generateIntermediateProof(mainWitness)

// Bob runs this 👇
Expand All @@ -178,7 +178,7 @@ const { proofAsFields, vkAsFields, vkHash } = await backends.main.generateInterm
proof,
numPublicInputs,
);
const recursiveProof = await noirs.recursive.generateFinalProof(recursiveInputs)
const recursiveProof = await noir_programs.recursive.generateFinalProof(recursiveInputs)
```

:::
4 changes: 2 additions & 2 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Noir, a domain-specific language crafted for SNARK proving systems, stands out w
and robust capabilities. Unlike conventional approaches that compile directly to a fixed NP-complete language,
Noir takes a two-pronged path. It first compiles to an adaptable intermediate language known as ACIR. From there,
depending on the project's needs, ACIR can be further compiled into an arithmetic circuit for integration with Aztec's
barretenberg backend or transformed into a rank-1 constraint system suitable for R1CS backends like Arkwork's Marlin
barretenberg backend or transformed into a rank-1 constraint system suitable for R1CS backends like Arkworks' Marlin
backend, among others.

This innovative design introduces unique challenges, yet it strategically separates the programming language from the
Expand All @@ -43,7 +43,7 @@ contracts efficiently. While the current alpha version offers this as a direct f
to modularize this process for even greater ease of use.

Noir currently includes a command to create a Solidity contract which verifies your Noir program. This will be
modularised in the future; however, as of the alpha, you can use the `nargo codegen-verifier` command to create a verifier contract.
modularized in the future; however, as of the alpha, you can use the `nargo codegen-verifier` command to create a verifier contract.

### Protocol Developers

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/noir/modules_packages_crates/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ For example, this file structure has a library and binary crate
│   ├── Nargo.toml
│   └── src
│   └── main.nr
└── liba
└── lib_a
├── Nargo.toml
└── src
└── lib.nr
Expand All @@ -61,17 +61,17 @@ Inside of the binary crate, you can specify:
# Nargo.toml

[dependencies]
libA = { path = "../liba" }
lib_a = { path = "../lib_a" }
```

## Importing dependencies

You can import a dependency to a Noir file using the following syntax. For example, to import the
ecrecover-noir library and local liba referenced above:
ecrecover-noir library and local lib_a referenced above:

```rust
use dep::ecrecover;
use dep::libA;
use dep::lib_a;
```

You can also import only the specific parts of dependency that you want to use, like so:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/noir/modules_packages_crates/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Noir's module system follows the same convention as the _newer_ version of Rust'

## Purpose of Modules

Modules are used to organise files. Without modules all of your code would need to live in a single
Modules are used to organize files. Without modules all of your code would need to live in a single
file. In Noir, the compiler does not automatically scan all of your files to detect modules. This
must be done explicitly by the developer.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/noir/syntax/data_types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ fn main() {

### BigInt

You can acheive BigInt functionality using the [Noir BigInt](https://github.com/shuklaayush/noir-bigint) library.
You can achieve BigInt functionality using the [Noir BigInt](https://github.com/shuklaayush/noir-bigint) library.
4 changes: 2 additions & 2 deletions docs/docs/noir/syntax/mutability.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ fn main(x : Field, y : [Field; N]) {

assert(res == y[0]);

let res2 = x * mysubmodule::N;
let res2 = x * my_submodule::N;
assert(res != res2);
}

mod mysubmodule {
mod my_submodule {
use dep::std;

global N: Field = 10;
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/noir/syntax/ops.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ fn main(x : Field) {

Noir has no support for the logical operators `||` and `&&`. This is because encoding the
short-circuiting that these operators require can be inefficient for Noir's backend. Instead you can
use the bitwise operators `|` and `&` which operate indentically for booleans, just without the
use the bitwise operators `|` and `&` which operate identically for booleans, just without the
short-circuiting.

```rust
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/noir/syntax/unconstrained.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ keywords: [Noir programming language, unconstrained, open]
sidebar_position: 5
---

Unconstrained functions are functions which do not constrain any of the included computation and allow for non-determinisitic computation.
Unconstrained functions are functions which do not constrain any of the included computation and allow for non-deterministic computation.

## Why?

Expand Down
Loading

1 comment on commit 194939c

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

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

🎉 Published on https://noir-lang.org as production
🚀 Deployed on https://6582d35f30feee05019257e6--noir-docs.netlify.app

Please sign in to comment.