Updating state machine documentation

andreev-io · Dec 18, 2021 · 9a2f45e · 9a2f45e
1 parent b1c56e4
commit 9a2f45e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/little_raft/src/state_machine.rs b/little_raft/src/state_machine.rs
@@ -6,7 +6,6 @@ use std::fmt::Debug;
 pub enum TransitionState {
     /// Queued transitions have been received from the user but have not been
     /// processed yet. They are in the queue.
-    ///
     Queued,
 
     /// Committed transitions have not yet been applied to the state machine but
@@ -22,10 +21,12 @@ pub enum TransitionState {
     Abandoned(TransitionAbandonedReason),
 }
 
+/// TransitionAbandonedReason explains why a particular transition has been
+/// abandoned by the replica.
 #[derive(Clone, Debug, PartialEq)]
 pub enum TransitionAbandonedReason {
-    // NotLeader transitions have been abandoned because the replica is not
-    // the cluster leader.
+    /// NotLeader transitions have been abandoned because the replica is not the
+    /// cluster leader.
     NotLeader,
 }
 

diff --git a/little_raft/src/timer.rs b/little_raft/src/timer.rs
@@ -32,4 +32,4 @@ impl Timer {
 
         rx
     }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -32,4 +32,4 @@ impl Timer { @@
             rx
         }
-    }
+    }