Skip to content

Commit

Permalink
chore: redo typo PR by osrm (#7238)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomAFrench authored Feb 10, 2025
1 parent 1a2a08c commit 40bb201
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/docs/how_to/debugger/debugging_with_vs_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ We can also inspect the values of variables by directly hovering on them on the

Let's set a break point at the `keccak256` function, so we can continue execution up to the point when it's first invoked without having to go one step at a time.

We just need to click the to the right of the line number 18. Once the breakpoint appears, we can click the `continue` button or use its corresponding keyboard shortcut (`F5` by default).
We just need to click to the right of the line number 18. Once the breakpoint appears, we can click the `continue` button or use its corresponding keyboard shortcut (`F5` by default).

![Breakpoint](@site/static/img/debugger/7-break.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Every crate has a root, which is the source file that the compiler starts, this

## Packages

A Nargo _package_ is a collection of one of more crates that provides a set of functionality. A package must include a Nargo.toml file.
A Nargo _package_ is a collection of one or more crates that provides a set of functionality. A package must include a Nargo.toml file.

A package _must_ contain either a library or a binary crate, but not both.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/noir/modules_packages_crates/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3

Workspaces are a feature of nargo that allow you to manage multiple related Noir packages in a single repository. A workspace is essentially a group of related projects that share common build output directories and configurations.

Each Noir project (with it's own Nargo.toml file) can be thought of as a package. Each package is expected to contain exactly one "named circuit", being the "name" defined in Nargo.toml with the program logic defined in `./src/main.nr`.
Each Noir project (with its own Nargo.toml file) can be thought of as a package. Each package is expected to contain exactly one "named circuit", being the "name" defined in Nargo.toml with the program logic defined in `./src/main.nr`.

For a project with the following structure:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/noir/standard_library/is_unconstrained.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Is Unconstrained Function
description:
The is_unconstrained function returns wether the context at that point of the program is unconstrained or not.
The is_unconstrained function returns whether the context at that point of the program is unconstrained or not.
keywords:
[
unconstrained
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ bb prove -b ./target/hello_world.json -w ./target/hello_world.gz -o ./target/pro

:::tip

Naming can be confusing, specially as you pass them to the `bb` commands. If unsure, it won't hurt to delete the target folder and start anew to make sure you're using the most recent versions of the compiled circuit and witness.
Naming can be confusing, especially as you pass them to the `bb` commands. If unsure, it won't hurt to delete the target folder and start anew to make sure you're using the most recent versions of the compiled circuit and witness.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ We can also inspect the values of variables by directly hovering on them on the

Let's set a break point at the `keccak256` function, so we can continue execution up to the point when it's first invoked without having to go one step at a time.

We just need to click the to the right of the line number 18. Once the breakpoint appears, we can click the `continue` button or use its corresponding keyboard shortcut (`F5` by default).
We just need to click to the right of the line number 18. Once the breakpoint appears, we can click the `continue` button or use its corresponding keyboard shortcut (`F5` by default).

![Breakpoint](@site/static/img/debugger/7-break.png)

Now we are debugging the `keccak256` function, notice the _Call Stack pane_ at the lower right. This lets us inspect the current call stack of our process.

That covers most of the current debugger functionalities. Check out [the reference](../../reference/debugger/debugger_vscode.md) for more details on how to configure the debugger.
That covers most of the current debugger functionalities. Check out [the reference](../../reference/debugger/debugger_vscode.md) for more details on how to configure the debugger.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3

Workspaces are a feature of nargo that allow you to manage multiple related Noir packages in a single repository. A workspace is essentially a group of related projects that share common build output directories and configurations.

Each Noir project (with it's own Nargo.toml file) can be thought of as a package. Each package is expected to contain exactly one "named circuit", being the "name" defined in Nargo.toml with the program logic defined in `./src/main.nr`.
Each Noir project (with its own Nargo.toml file) can be thought of as a package. Each package is expected to contain exactly one "named circuit", being the "name" defined in Nargo.toml with the program logic defined in `./src/main.nr`.

For a project with the following structure:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ fn checked_transmute<T, U>(value: T) -> U
Transmutes a value of one type into the same value but with a new type `U`.

This function is safe to use since both types are asserted to be equal later during compilation after the concrete values for generic types become known.
This function is useful for cases where the compiler may fails a type check that is expected to pass where
This function is useful for cases where the compiler may fail a type check that is expected to pass where
a user knows the two types to be equal. For example, when using arithmetic generics there are cases the compiler
does not see as equal, such as `[Field; N*(A + B)]` and `[Field; N*A + N*B]`, which users may know to be equal.
In these cases, `checked_transmute` can be used to cast the value to the desired type while also preserving safety
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When writing firmware for a battery-powered microcontroller, you think of cpu cy

> Code is written to create applications that perform specific tasks within specific constraints
And these constraints differ depending on where the compiled code is execute.
And these constraints differ depending on where the compiled code is executed.

### The Ethereum Virtual Machine (EVM)

Expand Down

0 comments on commit 40bb201

Please sign in to comment.