Skip to content

Commit

Permalink
docs: fix comments
Browse files Browse the repository at this point in the history
  • Loading branch information
junha1 committed Aug 21, 2022
1 parent 10afd09 commit bea08e4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion common/src/crypto.rs
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ impl Signature {

/// A signature that is explicitly marked with the type of the signed data.
///
/// This implies that the signature is created by `Hash256::hash(serde_json::to_vec(T).unwrap())` where
/// This implies that the signature is created on `Hash256::hash(serde_json::to_vec(T).unwrap())`.
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Serialize, Deserialize)]
pub struct TypedSignature<T> {
pub signature: Signature,
Expand Down
10 changes: 5 additions & 5 deletions common/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ use serde::{Deserialize, Serialize};
use std::collections::{BTreeMap, BTreeSet};
use thiserror::Error;

/// A set of state that is directly recorded in the header.
/// The state that is directly recorded in the header.
///
/// This state effects the consensus, unlike the ordinary state (which is used for data recording).
/// This state affects the consensus, unlike the ordinary state (which is used for data recording).
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
pub struct EssentialState {
/// The original validator set information before the delegation calculation.
///
/// The order here is the priority order of the validators
/// which directly effects the result of `calculate_net_validator_set()`.
/// The order here is the leader selection priority order of the validators
/// which directly affects the result of `calculate_net_validator_set()`.
pub validator_set: Vec<(PublicKey, u64)>,
/// The protocol version that must be used from next block.
///
Expand All @@ -24,7 +24,7 @@ pub struct EssentialState {
}

impl EssentialState {
/// Calculate the actual set of validator & voteing power for the next block.
/// Calculate the actual set of validators & voting power for the next block.
///
/// The order here is same as the order of leaders in each round.
/// returns `None` if the delegation is not valid.
Expand Down

0 comments on commit bea08e4

Please sign in to comment.