Skip to content

Commit 7d14aff

Browse files
authored
Docs: fix typos (#12724)
1 parent 318dc05 commit 7d14aff

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

chain/chunks/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ This crate contains functions to handle chunks. In NEAR - the block consists of
55
When a chunk is created, the creator encodes its contents using Reed Solomon encoding (ErasureCoding) and adds cross-shard receipts - creating PartialEncodedChunks that are later sent to all the validators (each validator gets a subset of them). This is done for data availability reasons (so that we need only a part of the validators to reconstruct the whole chunk). You can read more about it in [the Nightshade paper](https://near.org/papers/nightshade).
66

77

8-
A honest validator will only approve a block if it receives its assigned parts for all chunks in the block - which means that for each chunk, it has `has_all_parts()` returning true.
8+
An honest validator will only approve a block if it receives its assigned parts for all chunks in the block - which means that for each chunk, it has `has_all_parts()` returning true.
99

1010
For all nodes (validators and non-validators), they will only accept/process a block if the following requirements are satisfied:
1111

1212
* for every shard it tracks, a node has to have the full chunk,
13-
* for every shard it doesn't track, a node has have the receipts from this shard to all shards
13+
* for every shard it doesn't track, a node has the receipts from this shard to all shards
1414

1515

1616
If node tracks given shard (that is - it wants to have a whole content of the shard present in the local memory) - it will want to receive the necessary amount of PartialChunks to be able to reconstruct the whole chunk. As we use ReedSolomon, this means that they need `data_shard_count` PartialChunks (which is lower than `total_shard_count`). Afterwards, it will reconstruct the chunk and persist it in the local storage (via chain/client).

chain/epoch-manager/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Main class that has two main functions:
1616
When 'finalize_epoch' is called, the EpochManager will do all the necessary processing (like computing validator rewards for the current epoch (T), selecting validators for the next next epoch (T+2) etc) and create the new EpochId/EpochInfo.
1717

1818
### Accessing epoch information
19-
EpochManager has also a lot of methords that allows you to fetch information from different past and present epochs (like who is the chunk/block producer for a given chunk/block, whether the block is at the end of epoch boundary and requires more signatures etc)
19+
EpochManager has also a lot of methods that allows you to fetch information from different past and present epochs (like who is the chunk/block producer for a given chunk/block, whether the block is at the end of epoch boundary and requires more signatures etc)
2020

2121

2222
## RewardCalculator
@@ -31,7 +31,7 @@ and the new implementation present in the code - with new code existing in `vali
3131

3232

3333
## Shard assignments
34-
This code is responsible for assigning validators (and chunk producers) to shards (chunks). This wil be used only once we enable `chunk_only_producers` feature (as before, we're simply assigning all the validators to validate each chunk).
34+
This code is responsible for assigning validators (and chunk producers) to shards (chunks). This will be used only once we enable `chunk_only_producers` feature (as before, we're simply assigning all the validators to validate each chunk).
3535

3636

3737

chain/indexer/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## 1.32.x
1212

13-
* Add `nightly` feature to NEAR Indexer Framework to respect this feature for `nearcore` lib (requried for `betanet`)
13+
* Add `nightly` feature to NEAR Indexer Framework to respect this feature for `nearcore` lib (required for `betanet`)
1414

1515
## 1.26.0
1616

chain/jsonrpc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ communicated through the CHANGELOG next to this file.
1919

2020
1. We only add the APIs to the data that is already available in nearcore
2121
storage.
22-
2. We don't violate the guaranties described in the section above.
22+
2. We don't violate the guarantees described in the section above.
2323
3. We prefix new APIs with `EXPERIMENTAL_` (see the Experimental API Policies
2424
below).
2525
4. We document the API change on [NEAR Docs](https://docs.near.org/api/rpc/introduction)

docs/practices/workflows/otel_traces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`neard` is instrumented in a few different ways. From the code perspective we have two major ways
44
of instrumenting code:
55

6-
* Prometheus metrics – by computing various metrics in code and expoding them via the `prometheus`
6+
* Prometheus metrics – by computing various metrics in code and exposing them via the `prometheus`
77
crate.
88
* Execution tracing – this shows up in the code as invocations of functionality provided by the
99
`tracing` crate.

docs/practices/workflows/profiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ $ cargo build --release -p bytehound-preload
136136
$ cargo build --release -p bytehound-cli
137137
```
138138

139-
You will also need a build of your `neard`, once you have that, give it some ambient cabapilities
139+
You will also need a build of your `neard`, once you have that, give it some ambient capabilities
140140
necessary for profiling:
141141

142142
```command

0 commit comments

Comments
 (0)