bendns' repos / rust-fsm
Finite state machines in rust; bendns fork to add types.
Diffstat
-rw-r--r--README.md2
-rw-r--r--rust-fsm/src/lib.rs10
2 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 736be7c..0f98d1d 100644
--- a/README.md
+++ b/README.md
@@ -125,6 +125,8 @@ transition.
You can specify visibility like this:
```rust
+use rust_fsm::*;
+
state_machine! {
pub CircuitBreaker(Closed)
diff --git a/rust-fsm/src/lib.rs b/rust-fsm/src/lib.rs
index a7a357b..752a9b4 100644
--- a/rust-fsm/src/lib.rs
+++ b/rust-fsm/src/lib.rs
@@ -118,13 +118,15 @@
//! transition.
//!
//! ### Visibility
-//!
+//!
//! You can specify the module visibility like this:
//!
//! ```rust
+//! use rust_fsm::*;
+//!
//! state_machine! {
//! pub CircuitBreaker(Closed)
-//!
+//!
//! Closed(Unsuccessful) => Open [SetupTimer],
//! Open(TimerTriggered) => HalfOpen,
//! HalfOpen => {
@@ -133,9 +135,9 @@
//! }
//! }
//! ```
-//!
+//!
//! The default visibility is private.
-//!
+//!
//! ## Without DSL
//!
//! The `state_machine` macro has limited capabilities (for example, a state