From 0a3a0165ad10cb560efa6713e7a71914a504b4ef Mon Sep 17 00:00:00 2001 From: joao <22820692+joaolago1113@users.noreply.github.com> Date: Thu, 14 Dec 2023 16:44:30 +0000 Subject: [PATCH] Documentation Improvements: Typos and Grammar Fixes (#34461) * 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 --- ci/docker-rust/README.md | 4 ++-- docs/src/implemented-proposals/tower-bft.md | 2 +- tokens/README.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ci/docker-rust/README.md b/ci/docker-rust/README.md index 3984a64909..3f81847686 100644 --- a/ci/docker-rust/README.md +++ b/ci/docker-rust/README.md @@ -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 diff --git a/docs/src/implemented-proposals/tower-bft.md b/docs/src/implemented-proposals/tower-bft.md index ef34d11eae..c8a7819bbf 100644 --- a/docs/src/implemented-proposals/tower-bft.md +++ b/docs/src/implemented-proposals/tower-bft.md @@ -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)`. diff --git a/tokens/README.md b/tokens/README.md index e63f363d7c..be10c8211e 100644 --- a/tokens/README.md +++ b/tokens/README.md @@ -120,7 +120,7 @@ solana-tokens distribute-stake --stake-account-address \ --stake-authority --withdraw-authority --fee-payer ``` -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