Updated comments and examples

Author: kmvanbrunt

cmd2.py

@@ -2096,6 +2096,7 @@ def complete(self, text, state):
                         common_prefix = os.path.commonprefix(self.completion_matches)
 
                         if matches_delimited:
+                            # Check if any of the display matches are part of the tab completion text
                             display_prefix = os.path.commonprefix(self.display_matches)
 
                             # For delimited matches, we check what appears before the display

examples/tab_completion.py

@@ -8,8 +8,8 @@
 from cmd2 import with_argparser, with_argument_list
 
 # List of strings used with flag and index based completion functions
-food_item_strs = ['Pizza', 'Hamburger', 'Ham', 'Potato']
-sport_item_strs = ['Bat', 'Basket', 'Basketball', 'Football']
+food_item_strs = ['Pizza', 'Ham', 'Ham Sandwich', 'Potato']
+sport_item_strs = ['Bat', 'Basket', 'Basketball', 'Football', 'Space Ball']
 
 
 class TabCompleteExample(cmd2.Cmd):

tests/test_completion.py

@@ -458,7 +458,7 @@ def test_delimiter_completion(cmd2_app):
     display_list = list(display_set)
     display_list.sort()
 
-    assert display_list == ['otheruser', 'user']
+    assert display_list == ['other user', 'user']
 
 def test_flag_based_completion_single(cmd2_app):
     text = 'Pi'