From 4d6cfaac1c439b8d936de55c6dd77e4d40871f45 Mon Sep 17 00:00:00 2001
From: timofey <tim@ongoteam.yaconnect.com>
Date: Tue, 25 Apr 2023 15:03:20 +0000
Subject: [PATCH] istate docs

---
 src/flow.rs        | 2 +-
 src/func/istate.rs | 8 +++++++-
 src/lib.rs         | 3 +++
 3 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/src/flow.rs b/src/flow.rs
index ed64186..60bd286 100644
--- a/src/flow.rs
+++ b/src/flow.rs
@@ -1,3 +1,3 @@
-//! Data structures and algorithms, independent of [crate::core] concepts.
+//! Data structures and algorithms, independent of [`crate::core`] concepts.
 
 pub mod traversible;
diff --git a/src/func/istate.rs b/src/func/istate.rs
index 913290c..2efd8e4 100644
--- a/src/func/istate.rs
+++ b/src/func/istate.rs
@@ -1,10 +1,16 @@
 use super::*;
 
-/// Represents iteration state.
+/// Represents iteration state. Used in [`Monad::ibind`].
+///
+/// [`IState<P, D>`] is isomorphic to [`Result<D, P>`].
 pub enum IState<P, D> {
     /// Loop running.
+    ///
+    /// Isomorphic to [`Result::Err`].
     Pending(P),
     /// Loop finished.
+    ///
+    /// Isomorphic to [`Result::Ok`].
     Done(D),
 }
 
diff --git a/src/lib.rs b/src/lib.rs
index e91b794..a9eb7b0 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,6 @@
+//! # RADN
+//! Rainbow something something Network.
+
 pub mod core;
 pub mod flow;
 pub mod func;