Skip to content

Commit

Permalink
fix: fix docs
Browse files Browse the repository at this point in the history
Signed-off-by: Cem Onem <[email protected]>
  • Loading branch information
Cem Onem committed Dec 6, 2024
1 parent f1b822c commit 15afd25
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions src/validation/validation_stack.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
//! This module contains the [`ValidationStack`] data structure
//!
//! The [`ValidationStack`] is a unified stack, in the sense that it unifies both
//! [`ValidationStackEntry::Val`] and [`ValidationStackEntry::Label`]. It therefore mixes type
//! information with structured control flow information.
#![allow(unused)] // TODO remove this once sidetable implementation lands
use super::Result;
use alloc::vec;
Expand Down Expand Up @@ -63,7 +58,7 @@ impl ValidationStack {
self.stack.push(ValidationStackEntry::Val(valtype));
}

/// Similar to [`ValidationStack::pop`], because it pops a value from the stack,
/// Similar to [`ValidationStack::pop_valtype`], because it pops a value from the stack,
/// but more public and doesn't actually return the popped value.
pub(super) fn drop_val(&mut self) -> Result<()> {
self.pop_valtype().map_err(|e| Error::ExpectedAnOperand)?;
Expand Down Expand Up @@ -205,8 +200,7 @@ impl ValidationStack {
/// [`ValidationStackEntry`], the second last `expected_val_types` element to the second top-most
/// [`ValidationStackEntry`] etc.
///
/// Any occurence of the [`ValidationStackEntry::Label`] variant in the stack tail will cause an
/// error.
/// Any unification failure or arity mismatch will cause an error.
///
/// Any occurence of an error may leave the stack in an invalid state.
///
Expand Down

0 comments on commit 15afd25

Please sign in to comment.