From afa6bb3882e8a8e153241a70794f5942c85543a7 Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@daniel.shahaf.name>
Date: Thu, 29 Oct 2015 19:58:23 +0200
Subject: [PATCH] states work: Extend state machine documentation.

---
 highlighters/main/main-highlighter.zsh | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/highlighters/main/main-highlighter.zsh b/highlighters/main/main-highlighter.zsh
index 8fa7dda..db28998 100644
--- a/highlighters/main/main-highlighter.zsh
+++ b/highlighters/main/main-highlighter.zsh
@@ -131,6 +131,11 @@ _zsh_highlight_main_highlighter()
   # - :regular:    "Not a command word".
   #                Mainly used to detect premature termination of commands.
   #
+  # When the kind of a word is not yet known, $this_word / $next_word may contain
+  # multiple states.  For example, after "sudo -i", the next word may be either
+  # another --flag or a command name, hence the state would include both :start:
+  # and :sudo_opt:.
+  #
   # The tokens are always added with both leading and trailing colons to serve as
   # word delimiters (an improvised array); [[ $x == *:foo:* ]] and x=${x//:foo:/} 
   # will DTRT regardless of how many elements or repetitions $x has..