Skip to content

Commit

Permalink
fix: fix documentation (#194)
Browse files Browse the repository at this point in the history
  • Loading branch information
yair-starkware authored Mar 17, 2024
1 parent f2012e6 commit a50e621
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions src/state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,12 @@ impl StateNumber {
StateNumber(block_number)
}

/// The state at the end of the block.
/// Returns None if the block number is the maximum value.
/// The state at the end of the block, or None if it's is out of range.
pub fn right_after_block(block_number: BlockNumber) -> Option<StateNumber> {
Some(StateNumber(block_number.next()?))
}

/// The state at the end of the block.
/// Panics if the block number is the maximum value.
/// The state at the end of the block, without checking if it's in range.
pub fn unchecked_right_after_block(block_number: BlockNumber) -> StateNumber {
StateNumber(block_number.unchecked_next())
}
Expand Down

0 comments on commit a50e621

Please sign in to comment.