docs: fix typos in doc comments

This commit is contained in:
Bobbin Threadbare
2023-02-17 11:58:23 -08:00
parent 2d97153fd0
commit 3c9a5235a0
3 changed files with 12 additions and 10 deletions

View File

@@ -68,7 +68,7 @@ impl MerkleTree {
/// # Errors
/// Returns an error if:
/// * The specified depth is greater than the depth of the tree.
/// * The specified index not valid for the specified depth.
/// * The specified index is not valid for the specified depth.
pub fn get_node(&self, index: NodeIndex) -> Result<Word, MerkleError> {
if index.is_root() {
return Err(MerkleError::DepthTooSmall(index.depth()));
@@ -88,7 +88,7 @@ impl MerkleTree {
/// # Errors
/// Returns an error if:
/// * The specified depth is greater than the depth of the tree.
/// * The specified value not valid for the specified depth.
/// * The specified value is not valid for the specified depth.
pub fn get_path(&self, mut index: NodeIndex) -> Result<MerklePath, MerkleError> {
if index.is_root() {
return Err(MerkleError::DepthTooSmall(index.depth()));