address comments

Author: srbalakr

app/backend/approaches/chatreadretrieveread.py

@@ -115,8 +115,10 @@ def get_chat_history_as_text(self, history: Sequence[dict[str, str]], include_la
                 break    
         return history_text
 
-    # Generate messages needed for chat Completion api
     def get_messages_from_history(self, prompt_override, follow_up_questions_prompt, history: Sequence[dict[str, str]], sources: str, approx_max_tokens: int = 1000) -> []:
+        '''
+        Generate messages needed for chat Completion api
+        '''
         messages = []
         token_count = 0
         if prompt_override is None:
@@ -160,7 +162,7 @@ def num_tokens_from_messages(self, message: dict[str,str], model: str) -> int:
         Returns:
             int: The total number of tokens required to encode the message.
         Example:
-            message = {'role': 'user', 'name': 'John', 'content': 'Hello, how are you?'}
+            message = {'role': 'user', 'content': 'Hello, how are you?'}
             model = 'gpt-3.5-turbo'
             num_tokens_from_messages(message, model)
             output: 11