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

Fix typos #2248

Merged
merged 8 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/source/development/dev-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ private:
};

// 3. instead, create an interface for "Hasher":
// "Interface" leyer
// "Interface" layer
class Hasher {
public:
virtual ~Hasher() = default;
Expand Down
10 changes: 5 additions & 5 deletions docs/source/development/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ All used terms are described in [terms.md](./terms.md).

6. **major design rule** - avoid using preprocessor macros in header files except as include guards.

7. **major design rule** - only classes, structures, unions and free operator functions should be *declared* at file scope in `.h` file. Only classes, structures , unions, and inline (member or free operator) functions should be *defined* at file scope in a `.h` file.
7. **major design rule** - only classes, structures, unions and free operator functions should be *declared* at file scope in `.h` file. Only classes, structures, unions, and inline (member or free operator) functions should be *defined* at file scope in a `.h` file.

8. **major design rule** - place a unique and predictable (internal) include guard around the contents of each header file.

Expand Down Expand Up @@ -99,11 +99,11 @@ All used terms are described in [terms.md](./terms.md).

Example: defining an iterator class along with a container class in the same component enables user extensibility, improves maintainability and enhances reusability while preserving encapsulation.

21. **principle** - all tests must be done in isolation. Testing a component in isolation is an effective way to ensure reliability.
21. **principle** - all tests must be done in isolation. Testing a component in isolation is an effective way to ensure reliability.

22. **principle** - every directed acyclic graph can be assigned unique level numbers; a graph with cycles cannot. A physical dependency graph that can be assigned unique level numbers is said to be *levelizable*.

23. **principle** - in most real-world situations, large designs must be levelizable if they are able to be tested effectively.
23. **principle** - in most real-world situations, large designs must be levelizable if they are able to be tested effectively.

24. **principle** - testing only the functionality *directly implemented* within a component enables the complexity of the test to be proportional to the complexity of the component.

Expand All @@ -117,7 +117,7 @@ All used terms are described in [terms.md](./terms.md).

29. **major design rule** - prepend every global identifier with its package prefix.

30. **major design rule** - avoid cyclic dependencies among packages.
30. **major design rule** - avoid cyclic dependencies among packages.

31. **guideline** - avoid declaring results returned by value from functions as `const`.

Expand All @@ -129,7 +129,7 @@ All used terms are described in [terms.md](./terms.md).

35. **guideline** - explicitly declare (public or private) the constructor and assignment operator for any class defined in a header file.

36. **minor design rule** - in every class that declares or is derived from a class that declares a virtual function, explicitly declare the destructor as the first virtual function in the class and define it out of line.
36. **minor design rule** - in every class that declares or is derived from a class that declares a virtual function, explicitly declare the destructor as the first virtual function in the class and define it out of line.


[^1]: "John Lakos - Large Scale C++ Software Design".
4 changes: 2 additions & 2 deletions docs/source/overview/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ git submodule update --init --recursive

### Build

First build will likely take long time. However, you can cache binaries to [hunter-binary-cache](https://github.com/soramitsu/hunter-binary-cache) or even download binaries from the cache in case someone has already compiled project with the same compiler. To this end, you need to set up two environment variables:
First build will likely take a long time. However, you can cache binaries to [hunter-binary-cache](https://github.com/soramitsu/hunter-binary-cache) or even download binaries from the cache in case someone has already compiled project with the same compiler. To this end, you need to set up two environment variables:
```
GITHUB_HUNTER_USERNAME=<github account name>
GITHUB_HUNTER_TOKEN=<github token>
Expand All @@ -51,7 +51,7 @@ ctest

#### Build node application

If you'd like to build node use the following instruction
If you'd like to build node use the following instructions

```
mkdir build && cd build
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorials/kagome_in_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All Rights Reserved
SPDX-License-Identifier: Apache-2.0
)

## Runing Kagome in docker container
## Running Kagome in docker container

In this tutorial you will learn how to execute Kagome-based Polkadot-host chain which can be used as a cryptocurrency, and interact with it by sending extrinsics and executing queries.

Expand All @@ -31,7 +31,7 @@ docker run \ # Run docker container
--interactive \ # Interactive mode
--tty \ # Allocate pseudo-TTY
--rm \ # Remove container (not image) after stop
--user `id -u`:`id -g` \ # Delegate current user permitions in container
--user `id -u`:`id -g` \ # Delegate current user permissions in container
--volume `pwd`:/kagome \ # Map current directory to directory in container
--publish DOCKER_PORT:HOST_PORT \ # Bind ports
soramitsu/kagome \ # Name of docker image of Kagome
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/private_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Once activated, the second node performs several steps before beginning the actu

### Step 4: Start syncing node

Syncing node cannot participate in block production or block finalization. However, it can connect to the network and import all produced blocks. Besides that, syncing node can also receive extrinsics and broadcast them to the network.In the world of blockchain, a syncing node plays a unique role. While it can't contribute to block production or finalization, it serves as a connector to the network, importing all produced blocks. More than that, a syncing node can receive extrinsics and subsequently broadcast them to the network.
Syncing node cannot participate in block production or block finalization. However, it can connect to the network and import all produced blocks. Besides that, syncing node can also receive extrinsics and broadcast them to the network. In the world of blockchain, a syncing node plays a unique role. While it can't contribute to block production or finalization, it serves as a connector to the network, importing all produced blocks. More than that, a syncing node can receive extrinsics and subsequently broadcast them to the network.

To initiate a syncing node, you can use the binary `kagome` as outlined in the command below:

Expand Down
Loading