From ba1ab5d663c24ce1f6a1de48a703e50c3bd1fe6f Mon Sep 17 00:00:00 2001
From: Groot <ruffo324@gmail.com>
Date: Thu, 19 Aug 2021 12:46:50 +0200
Subject: [PATCH] Used <summary> comments in AutoCompletion example

---
 README.md | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5f01dd1..21f4a42 100644
--- a/README.md
+++ b/README.md
@@ -88,11 +88,16 @@ _Note: History information is persisted for an entire application session. Also,
 ```csharp
 class AutoCompletionHandler : IAutoCompleteHandler
 {
-    // characters to start completion from
+    /// <summary>
+    /// Characters to start completion from.
+    /// </summary>
     public char[] Separators { get; set; } = new char[] { ' ', '.', '/' };
 
-    // text - The current text entered in the console
-    // index - The index of the terminal cursor within {text}
+    /// <summary>
+    /// Used to resolve possible completions.
+    /// </summary>
+    /// <param name="text">The current text entered in the console.</param>
+    /// <param name="index">The index of the terminal cursor within <paramref name="text"/>.</param>
     public string[] GetSuggestions(string text, int index)
     {
         if (text.StartsWith("git "))