-
Notifications
You must be signed in to change notification settings - Fork 27
Open
Description
Summary
The "Develop Miden in Rust" compiler guide (versioned_docs/version-0.12/compiler/guides/develop_miden_in_rust.md) contains an unresolved TODO placeholder in published documentation.
Problem
The guide states:
TODO: Add examples of using operations on
Felttype and available functions (assert*, etc.)
This is a development placeholder that was published as-is. The guide covers Felt initialization (felt! macro and Felt::new) but stops short of documenting:
- Arithmetic operations on
Felt(+,-,*,/and their wrapping/modulo behavior) - Available assertion functions (
assert*) - Practical usage patterns combining these operations
- Error handling for values outside the valid field range (0 to 2^64 - 2^32 + 1)
Impact
Developers following this guide to build Miden programs in Rust reach a gap at the point where they need to actually use Felt values in operations. The guide sets up the type but doesn't show how to work with it.
Suggested Fix
Either:
- Complete the section with examples of
Feltarithmetic, assertions, and common patterns - Or link to the
miden-stdlib-syscrate documentation / README where these operations may already be documented
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels