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

Correct typos and errors in code comments in docs #434

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contracts/docs/contract-style-guide.md
Original file line number Diff line number Diff line change
@@ -38,7 +38,7 @@ Contracts and interfaces will use the [NatSpec](https://docs.soliditylang.org/en
## General
- Avoid magic numbers by using constants
- Name variables so that their intent is easy to understand
- In assembly memory mappings use hexidecimal values for memory offsets - e.g `mstore(add(mPtr, 0x20), _varName)`
- In assembly memory mappings use hexadecimal values for memory offsets - e.g `mstore(add(mPtr, 0x20), _varName)`

## Linting
Be sure to run `pnpm run lint:fix` in the contracts folder or `pnpm run -F contracts lint:fix` from the repository root.
@@ -107,4 +107,4 @@ contract SampleContract {
// 6. Modifiers
// 7. Functions (Public, external, internal and then private)
}
```
```
2 changes: 1 addition & 1 deletion contracts/test/messageService/lib/Timelock.ts
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@ describe("Timelock", () => {
expect(await contract.hasRole(EXECUTOR_ROLE, executor.address)).to.be.true;
});

it("Should set the minDelay state variable with the value passed in the contructor params", async () => {
it("Should set the minDelay state variable with the value passed in the constructor params", async () => {
expect(await contract.getMinDelay()).to.equal(10);
});
});
2 changes: 1 addition & 1 deletion docs/get-started.md
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ pnpm run test:e2e:local
To stop that stack run:

```
make clean-enviroment
make clean-environment
```

While running the end2end tests, you should observe files being generated in `tmp/local/` directory.
2 changes: 1 addition & 1 deletion prover/maths/field/gen.go
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ import (
)

// ParBatchInvert is as a parallel implementation of [BatchInvert]. The caller
// can supply the target number of cores to use to perform the paralellization.
// can supply the target number of cores to use to perform the parallelization.
// If `numCPU=0` is provided, the function defaults to using all the available
// cores exposed by the OS.
func ParBatchInvert(a []Element, numCPU int) []Element {
2 changes: 1 addition & 1 deletion prover/symbolic/variable.go
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ import (
// used to instantiate a [Variable] with them.
type Metadata interface {
/*
Strings allows adressing a map by variable 2 instances for which
Strings allows addressing a map by variable 2 instances for which
String() returns the same result are treated as equal.
*/
String() string