📝 Documentation updates

This commit is contained in:
François Autin
2023-03-24 19:02:50 +01:00
parent 4e90d9fef7
commit 7ed53261a0
4 changed files with 39 additions and 12 deletions

View File

@ -1,3 +1,19 @@
//! # Error
//!
//! This module contains the definition of the MachineError struct,
//! for error management in the Machine module.
//!
//! Basic usage:
//!
//! ```
//! fn example(x: bool) -> Result<(), MachineError> {
//! match x {
//! true => Ok(()),
//! _ => Err(MachineError::new("Machine failed because of ..."));
//! }
//! }
//! ```
use std::fmt;
/// Machine Error