Skip to content

Commit

Permalink
Documentation Improvements: Typos and Grammar Fixes (solana-labs#34461)
Browse files Browse the repository at this point in the history
* fix typo: Change 'store it the recipient address' to 'store it in the recipient address'

* fix grammar in documentation: Remove 'of' from 'Both of docker images' and add 'is' to 'This image manually maintained'

* fix duplicate word in 'Voting Algorithm' section
  • Loading branch information
joaolago1113 authored Dec 14, 2023
1 parent 0be3b6e commit 0a3a016
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions ci/docker-rust/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Docker image containing rust and some preinstalled packages used in CI.

NOTE: Recreate rust-nightly docker image after this when updating the stable rust
version! Both of docker images must be updated in tandem.
version! Both docker images must be updated in tandem.

This image manually maintained:
This image is manually maintained:
1. Edit `Dockerfile` to match the desired rust version
1. Run `docker login` to enable pushing images to Docker Hub, if you're authorized.
1. Run `./build.sh` to publish the new image, if you are a member of the [Solana
Expand Down
2 changes: 1 addition & 1 deletion docs/src/implemented-proposals/tower-bft.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ ancestors.

Each validator maintains a vote tower `T` which follows the rules described above in [Vote Tower](#vote-tower), which is a sequence of blocks it has voted for (initially empty). The variable `l` records the length of the stack. For each entry in the tower, denoted by `B = T(x)` for `x < l` where `B` is the `xth` entry in the tower, we record also a value `confcount(B)`. Define the lock expiration slot `lockexp(B) := slot(B) + 2 ^ confcount(B)`.

The validator `i` runs a voting loop as as follows. Let `B` be the heaviest
The validator `i` runs a voting loop as follows. Let `B` be the heaviest
block returned by the fork choice rule above [Fork Choice](#fork-choice). If `i` has not voted for `B` before, then `i` votes for `B` so long as the following conditions are satisfied:

1. Respecting lockouts: For any block `B′` in the tower that is not an ancestor of `B`, `lockexp(B′) ≤ slot(B)`.
Expand Down
2 changes: 1 addition & 1 deletion tokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ solana-tokens distribute-stake --stake-account-address <ACCOUNT_ADDRESS> \
--stake-authority <KEYPAIR> --withdraw-authority <KEYPAIR> --fee-payer <KEYPAIR>
```

Currently, this will subtract 1 SOL from each allocation and store it the
Currently, this will subtract 1 SOL from each allocation and store it in the
recipient address. That SOL can be used to pay transaction fees on staking
operations such as delegating stake. The rest of the allocation is put in
a stake account. The new stake account address is output in the transaction
Expand Down

0 comments on commit 0a3a016

Please sign in to comment.