Skip to content

Commit 6957194

Browse files
authoredJan 18, 2025··
docs: fix quotation mark (#1577)
Fix quotation mark in .md and .go files.
1 parent be2047e commit 6957194

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed
 

‎config/config.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -976,11 +976,11 @@ type ConsensusConfig struct {
976976
TimeoutPropose time.Duration `mapstructure:"timeout_propose"`
977977
// How much timeout_propose increases with each round
978978
TimeoutProposeDelta time.Duration `mapstructure:"timeout_propose_delta"`
979-
// How long we wait after receiving +2/3 prevotes for anything (ie. not a single block or nil)
979+
// How long we wait after receiving +2/3 prevotes for "anything" (ie. not a single block or nil)
980980
TimeoutPrevote time.Duration `mapstructure:"timeout_prevote"`
981981
// How much the timeout_prevote increases with each round
982982
TimeoutPrevoteDelta time.Duration `mapstructure:"timeout_prevote_delta"`
983-
// How long we wait after receiving +2/3 precommits for anything (ie. not a single block or nil)
983+
// How long we wait after receiving +2/3 precommits for "anything" (ie. not a single block or nil)
984984
TimeoutPrecommit time.Duration `mapstructure:"timeout_precommit"`
985985
// How much the timeout_precommit increases with each round
986986
TimeoutPrecommitDelta time.Duration `mapstructure:"timeout_precommit_delta"`

‎config/toml.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -485,11 +485,11 @@ wal_file = "{{ js .Consensus.WalPath }}"
485485
timeout_propose = "{{ .Consensus.TimeoutPropose }}"
486486
# How much timeout_propose increases with each round
487487
timeout_propose_delta = "{{ .Consensus.TimeoutProposeDelta }}"
488-
# How long we wait after receiving +2/3 prevotes for anything (ie. not a single block or nil)
488+
# How long we wait after receiving +2/3 prevotes for "anything" (ie. not a single block or nil)
489489
timeout_prevote = "{{ .Consensus.TimeoutPrevote }}"
490490
# How much the timeout_prevote increases with each round
491491
timeout_prevote_delta = "{{ .Consensus.TimeoutPrevoteDelta }}"
492-
# How long we wait after receiving +2/3 precommits for anything (ie. not a single block or nil)
492+
# How long we wait after receiving +2/3 precommits for "anything" (ie. not a single block or nil)
493493
timeout_precommit = "{{ .Consensus.TimeoutPrecommit }}"
494494
# How much the timeout_precommit increases with each round
495495
timeout_precommit_delta = "{{ .Consensus.TimeoutPrecommitDelta }}"

‎spec/consensus/proposer-selection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ order: 3
55
# Proposer Selection Procedure
66

77
This document specifies the Proposer Selection Procedure that is used in Tendermint, the consensus algorithm adopted in CometBFT, to choose a round proposer.
8-
As Tendermint is leader-based consensus protocol, the proposer selection is critical for its correct functioning.
8+
As Tendermint is "leader-based consensus protocol", the proposer selection is critical for its correct functioning.
99

1010
At a given block height, the proposer selection algorithm runs with the same validator set at each round .
1111
Between heights, an updated validator set may be specified by the application as part of the ABCIResponses' EndBlock.

‎spec/light-client/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ version 001. The TLA+ properties can be found in the
103103
[TLA+ specification](verification/Lightclient_A_1.tla).
104104
The experiments were run in an AWS instance equipped with 32GB
105105
RAM and a 4-core Intel® Xeon® CPU E5-2686 v4 @ 2.30GHz CPU.
106-
We write ✗=k when a bug is reported at depth k, and ✓<=k when
106+
We write "✗=k" when a bug is reported at depth k, and "✓<=k" when
107107
no bug is reported up to depth k.
108108

109109
![Experimental results](experiments.png)

‎spec/p2p/config.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ and upon incoming connection shares some peers and disconnects.
1212

1313
## Seeds
1414

15-
`--p2p.seeds id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:4444`
15+
`--p2p.seeds "id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:4444"`
1616

1717
Dials these seeds when we need more peers. They should return a list of peers and then disconnect.
1818
If we already have enough peers in the address book, we may never need to dial them.
1919

2020
## Persistent Peers
2121

22-
`--p2p.persistent_peers id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:26656`
22+
`--p2p.persistent_peers "id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:26656"`
2323

2424
Dial these peers and auto-redial them if the connection fails.
2525
These are intended to be trusted persistent peers that can help
@@ -36,14 +36,14 @@ and that the node may not be able to keep the connection persistent.
3636

3737
## Private Peers
3838

39-
`--p2p.private_peer_ids id100000000000000000000000000000000,id200000000000000000000000000000000`
39+
`--p2p.private_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"`
4040

4141
These are IDs of the peers that we do not add to the address book or gossip to
4242
other peers. They stay private to us.
4343

4444
## Unconditional Peers
4545

46-
`--p2p.unconditional_peer_ids id100000000000000000000000000000000,id200000000000000000000000000000000`
46+
`--p2p.unconditional_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"`
4747

4848
These are IDs of the peers which are allowed to be connected by both inbound or outbound regardless of
4949
`max_num_inbound_peers` or `max_num_outbound_peers` of user's node reached or not.

‎spec/p2p/v0.34/configuration.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ These parameters can be set using the `$CMTHOME/config/config.toml` file. A subs
3232
| Parameter | Flag| Example|
3333
| --- | --- | ---|
3434
| Listen address| `p2p.laddr` | "tcp://0.0.0.0:26656" |
35-
| Seed nodes | `p2p.seeds` | `--p2p.seeds id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:4444` |
36-
| Persistent peers | `p2p.persistent_peers` | `--p2p.persistent_peers id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:26656` |
37-
| Unconditional peers | `p2p.unconditional_peer_ids` | `--p2p.unconditional_peer_ids id100000000000000000000000000000000,id200000000000000000000000000000000` |
35+
| Seed nodes | `p2p.seeds` | `--p2p.seeds "id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:4444"` |
36+
| Persistent peers | `p2p.persistent_peers` | `--p2p.persistent_peers "id100000000000000000000000000000000@1.2.3.4:26656,id200000000000000000000000000000000@2.3.4.5:26656"` |
37+
| Unconditional peers | `p2p.unconditional_peer_ids` | `--p2p.unconditional_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"` |
3838
| UPNP | `p2p.upnp` | `--p2p.upnp` |
3939
| PexReactor | `p2p.pex` | `--p2p.pex` |
4040
| Seed mode | `p2p.seed_mode` | `--p2p.seed_mode` |
41-
| Private peer ids | `p2p.private_peer_ids` | `--p2p.private_peer_ids id100000000000000000000000000000000,id200000000000000000000000000000000` |
41+
| Private peer ids | `p2p.private_peer_ids` | `--p2p.private_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"` |
4242

4343
**Note on persistent peers**
4444

0 commit comments

Comments
 (0)
Please sign in to comment.