From d2f583d217d4228f77bceb5f2d1949421e30cf01 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Thu, 2 Feb 2023 20:45:17 +0100 Subject: [PATCH] docs(all): fix typos (#3080) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Eclésio Junior --- .github/CONTRIBUTING.md | 2 +- docs/docs/getting-started/overview/package-library.md | 2 +- docs/docs/getting-started/resources/general-resources.md | 2 +- docs/docs/testing-and-debugging/pprof.md | 2 +- docs/docs/usage/configuration.md | 4 ++-- docs/docs/usage/import-runtime.md | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 691b6ff62c..db98c89722 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -65,7 +65,7 @@ For coding style, you may refer to the [code style](CODE_STYLE.md) document whic go test ``` - 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 diff --git a/docs/docs/getting-started/overview/package-library.md b/docs/docs/getting-started/overview/package-library.md index 79cacc8fa3..0d37ed4278 100644 --- a/docs/docs/getting-started/overview/package-library.md +++ b/docs/docs/getting-started/overview/package-library.md @@ -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` diff --git a/docs/docs/getting-started/resources/general-resources.md b/docs/docs/getting-started/resources/general-resources.md index 4c459238ac..b269bb3a5c 100644 --- a/docs/docs/getting-started/resources/general-resources.md +++ b/docs/docs/getting-started/resources/general-resources.md @@ -108,4 +108,4 @@ Gossamer is an implementation of the Polkadot Host in Go. To learn more about Go #### Articles -- Why Wy Need Web 3.0 - September 12th 2018 +- Why We Need Web 3.0 - September 12th 2018 diff --git a/docs/docs/testing-and-debugging/pprof.md b/docs/docs/testing-and-debugging/pprof.md index 68464e84b1..9edf611ea4 100644 --- a/docs/docs/testing-and-debugging/pprof.md +++ b/docs/docs/testing-and-debugging/pprof.md @@ -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. diff --git a/docs/docs/usage/configuration.md b/docs/docs/usage/configuration.md index 99c0230d18..19ff9c0981 100644 --- a/docs/docs/usage/configuration.md +++ b/docs/docs/usage/configuration.md @@ -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 @@ -56,4 +56,4 @@ modules = ["system", "author", "chain", "state", "rpc", "grandpa"] ws = true | false ws-external = true | false ws-port = 8546 -``` \ No newline at end of file +``` diff --git a/docs/docs/usage/import-runtime.md b/docs/docs/usage/import-runtime.md index e70af1e98f..759fd936dc 100644 --- a/docs/docs/usage/import-runtime.md +++ b/docs/docs/usage/import-runtime.md @@ -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 @@ -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! \ No newline at end of file +You now have a chain running a custom runtime!