Skip to content

Commit

Permalink
docs(all): fix typos (#3080)
Browse files Browse the repository at this point in the history
Co-authored-by: Eclésio Junior <eclesiomelo.1@gmail.com>
  • Loading branch information
omahs and EclesioMeloJunior committed Feb 2, 2023
1 parent 029240e commit d2f583d
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ For coding style, you may refer to the [code style](CODE_STYLE.md) document whic
go test <file_you_are_working_on>
```

Sometimes you may need to create mocks for interfaces, in that case, add a go generate comment. For example, for interface `Client` in the `dot/telemetry` pacakge, the comment would be:
Sometimes you may need to create mocks for interfaces, in that case, add a go generate comment. For example, for interface `Client` in the `dot/telemetry` package, the comment would be:

```go
//go:generate mockgen -destination=mock_myinterface_test.go -package $GOPACKAGE github.com/ChainSafe/gossamer/dot/telemetry Client
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/overview/package-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Gossamer packages can be categorized into **four package types**:

#### `lib/transaction`

- the **transaction package** is contains transaction types and the transaction queue data structure.
- the **transaction package** contains transaction types and the transaction queue data structure.

#### `lib/trie`

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/resources/general-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ Gossamer is an implementation of the Polkadot Host in Go. To learn more about Go

#### Articles

- <a target="_blank" rel="noopener noreferrer" href="https://medium.com/@gavofyork/why-we-need-web-3-0-5da4f2bf95ab">Why Wy Need Web 3.0</a> - September 12th 2018
- <a target="_blank" rel="noopener noreferrer" href="https://medium.com/@gavofyork/why-we-need-web-3-0-5da4f2bf95ab">Why We Need Web 3.0</a> - September 12th 2018
2 changes: 1 addition & 1 deletion docs/docs/testing-and-debugging/pprof.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ permalink: /testing-and-debugging/pprof

## Pprof

There is a built-in pprof server to faciliate profiling the program.
There is a built-in pprof server to facilitate profiling the program.
You can enable it with the flag `--pprofserver` or by modifying the TOML configuration file.

Note it does not affect performance unless the server is queried.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/usage/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ permalink: /usage/configuration/

# Configuration

Gossamer consumes a `.toml` file containing predefined settings for the node from setting the genesis file, to the RPC/WS server, this file allows you to curated the functionality of the node instead of writing out the flags manually
Gossamer consumes a `.toml` file containing predefined settings for the node from setting the genesis file, to the RPC/WS server, this file allows you to curate the functionality of the node instead of writing out the flags manually

## Full reference

Expand Down Expand Up @@ -56,4 +56,4 @@ modules = ["system", "author", "chain", "state", "rpc", "grandpa"]
ws = true | false
ws-external = true | false
ws-port = 8546
```
```
4 changes: 2 additions & 2 deletions docs/docs/usage/import-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Once you have your runtime ready and compiled into a wasm binary, it is ready to

### 1. Create genesis spec file with custom runtime

You can use the `gossamer import-runtime` subcommand to create a genesis file containin g your custom runtime. The rest of the file is based off the `gssmr` `genesis.json` file.
You can use the `gossamer import-runtime` subcommand to create a genesis file containing your custom runtime. The rest of the file is based off the `gssmr` `genesis.json` file.

```
make gossamer
Expand Down Expand Up @@ -54,4 +54,4 @@ The final step is to launch the node. This is the same as normal, providing a bu
./bin/gossamer --key alice
```

You now have a chain running a custom runtime!
You now have a chain running a custom runtime!

0 comments on commit d2f583d

Please sign in to comment.