reword the 'round' definition #351
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anorth
approved these changes
Jun 29, 2019
sternhenri
suggested changes
Jul 2, 2019
There was a problem hiding this comment.
I think this is generally good. We could be more specific still.
The 4 key elements imo:
- a round is the period over which a leader election decision is made
- a round may yield no decision or multiple
- we move on to the next round after some time has elapsed or once a decision is made
- we move to the next height once a decision is made
We have the first 2, missing last 2. I would add them.
My inspiration is here. I think they’ve done a great job w it.
|
@laser want to take a stab at improving this further? |
|
May take a stab if you're ok with it @laser @dignifiedquire given conflicting requests in #357 (cc @whyrusleeping @pooja) |
|
@sternhenri - Please do! I would very much appreciate that. |
Ready to merge from my end. |
This was referenced Jul 23, 2019
dignifiedquire
suggested changes
Jul 26, 2019
definitions.md
Outdated
| `Height` refers to the number of `TipSets` that have passed between this `TipSet` and the genesis block (which starts at block height 0). If a `TipSet` contains multiple blocks, each block in the TipSet will have the same `height`. | ||
| `Height` and `round` are synonymous and used interchangeably in this spec. | ||
|
|
||
| `Height` refers to the number of tickets generated between this `TipSet` and the genesis block (height 0), counting only a single ticket per TipSet. |
There was a problem hiding this comment.
the last part of this sentence is still confusing at best, wrong at worst.
sternhenri
approved these changes
Jul 26, 2019
mining.md
Outdated
| @@ -335,6 +334,7 @@ Heaviest tipset at H-1 is {B0} | |||
| - New Round with M mining atop B4 | |||
|
|
|||
| Anytime a miner receives new blocks, it should evaluate which is the heaviest TipSet it knows about and mine atop it. | |||
| >>>>>>> ca3f93b3497b870b513332d3cfee381b7590e993 | |||
There was a problem hiding this comment.
merge conflict detected
dignifiedquire
approved these changes
Jul 26, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why is this PR needed?
The previous wording was confusing. It was not clear (to me) that the definition of "round" applied to a period of time in which leader election occurred but no leader was found.
What's in this PR?
I've added more words to the "round" definition in hopes of reducing ambiguity.