Approval voting guide changes (#2347)

* grab guide updates from approval-voting branch

* focus on control flow and behavior, not functions

* add approval voting preamble info

* tabs -> spaces
This commit is contained in:
Robert Habermeier
2021-01-29 11:06:16 -06:00
committed by GitHub
parent 29f12f3f48
commit 956bc300c1
4 changed files with 117 additions and 71 deletions
@@ -5,11 +5,11 @@ Yields a vector of events concerning candidates that occurred within the given b
```rust
enum CandidateEvent {
/// This candidate receipt was backed in the most recent block.
CandidateBacked(CandidateReceipt, HeadData),
CandidateBacked(CandidateReceipt, HeadData, CoreIndex, GroupIndex),
/// This candidate receipt was included and became a parablock at the most recent block.
CandidateIncluded(CandidateReceipt, HeadData),
CandidateIncluded(CandidateReceipt, HeadData, CoreIndex, GroupIndex),
/// This candidate receipt was not made available in time and timed out.
CandidateTimedOut(CandidateReceipt, HeadData),
CandidateTimedOut(CandidateReceipt, HeadData, CoreIndex),
}
fn candidate_events(at: Block) -> Vec<CandidateEvent>;