Skip to content

Commit 3d813bc

Browse files
committed
improve and update docs
1 parent 1f4febf commit 3d813bc

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

crates/wasmi/src/engine/translator/func2/stack/mod.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,8 @@ impl Stack {
425425
///
426426
/// # Note
427427
///
428-
/// Returns the [`Operand`] at `depth` before being converted to an [`Operand::Temp`].
428+
/// - Returns the [`Operand`] at `depth` before being converted to an [`Operand::Temp`].
429+
/// - [`Operand::Temp`] will have their optional `instr` set to `None`.
429430
///
430431
/// # Panics
431432
///

crates/wasmi/src/engine/translator/func2/stack/operands.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,8 @@ impl OperandStack {
233233
///
234234
/// # Note
235235
///
236-
/// Returns the [`Operand`] at `depth` before being converted to an [`Operand::Temp`].
236+
/// - Returns the [`Operand`] at `depth` before being converted to an [`Operand::Temp`].
237+
/// - [`Operand::Temp`] will have their optional `instr` set to `None`.
237238
///
238239
/// # Panics
239240
///
@@ -249,7 +250,8 @@ impl OperandStack {
249250
///
250251
/// # Note
251252
///
252-
/// Returns `None` if operand at `index` is [`StackOperand::Temp`] already.
253+
/// - Returns the [`Operand`] at `index` before being converted to an [`Operand::Temp`].
254+
/// - [`Operand::Temp`] will have their optional `instr` set to `None`.
253255
///
254256
/// # Panics
255257
///

0 commit comments

Comments
 (0)