a temporary check point

just to save things in a commit

1 files changed, 6 insertions, 0 deletions

diff --git a/nfa/src/error.rs b/nfa/src/error.rs
index 6112878..0c6bb3c 100644
--- a/nfa/src/error.rs
+++ b/nfa/src/error.rs
@@ -5,9 +5,15 @@ use graph::error::Error as GError;
 use std::fmt::{Display, Formatter};
 
 #[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd)]
+/// The error type for NFA operations.
 pub enum Error {
+    /// An unknown node id is encountered.
     UnknownNode(usize),
+    /// Some operations are not supported by the implementations.
+    ///
+    /// Everything is a trade-off, wink wink.
     UnsupportedOperation,
+    /// This error comes from some underlying graph operation.
     Graph(GError),
 }