trivial: add more comments for simple_gui.py code

Signed-off-by: JoshWu <rainyfeeling@outlook.com>
dlnuxjy · Jan 5, 2021 · f08d5a7 · f08d5a7
1 parent 3ef08c1
commit f08d5a7
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/surround_view/simple_gui.py b/surround_view/simple_gui.py
@@ -1,7 +1,7 @@
 import cv2
 import numpy as np
 
-
+# return -1 if user press 'q'. return 1 if user press 'Enter'.
 def display_image(window_title, image):
     cv2.imshow(window_title, image)
     while True:
@@ -13,6 +13,7 @@ def display_image(window_title, image):
         if key == ord("q"):
             return -1
 
+        # 'Enter' key is detected!
         if key == 13:
             return 1