Merge remote-tracking branch 'upstream/master'

1 files changed, 8 insertions, 5 deletions

diff --git a/src/nvim/state.c b/src/nvim/state.c
index eb0b590a9b..4d9032b7a5 100644
--- a/src/nvim/state.c
+++ b/src/nvim/state.c
@@ -26,10 +26,11 @@ void state_enter(VimState *s)
     int check_result = s->check ? s->check(s) : 1;
 
     if (!check_result) {
-      break;
+      break;     // Terminate this state.
     } else if (check_result == -1) {
-      continue;
+      continue;  // check() again.
     }
+    // Execute this state.
 
     int key;
 
@@ -48,11 +49,13 @@ getkey:
       ui_flush();
       // Call `os_inchar` directly to block for events or user input without
       // consuming anything from `input_buffer`(os/input.c) or calling the
-      // mapping engine. If an event was put into the queue, we send K_EVENT
-      // directly.
+      // mapping engine.
       (void)os_inchar(NULL, 0, -1, 0);
       input_disable_events();
-      key = !multiqueue_empty(main_loop.events) ? K_EVENT : safe_vgetc();
+      // If an event was put into the queue, we send K_EVENT directly.
+      key = !multiqueue_empty(main_loop.events)
+            ? K_EVENT
+            : safe_vgetc();
     }
 
     if (key == K_EVENT) {