document mark actions

1 files changed, 5 insertions, 0 deletions

diff --git a/src/mode.rs b/src/mode.rs
index 778bf3f..8ded13d 100644
--- a/src/mode.rs
+++ b/src/mode.rs
@@ -1,8 +1,13 @@
 use std::fmt;
 
+/// Different kind of mark actions.
+/// Either we jump to an existing mark or we save current path to a mark.
+/// In both case, we'll have to listen to the next char typed.
 #[derive(Clone)]
 pub enum MarkAction {
+    /// Jump to a selected mark (ie a path associated to a char)
     Jump,
+    /// Creates a new mark (a path associated to a char)
     New,
 }