chore(chat): add some missing docs

Kujtim Hoxha created 1 week ago

Change summary

internal/ui/chat/messages.go | 4 ++++
internal/ui/model/ui.go      | 3 +++
2 files changed, 7 insertions(+)

Detailed changes

internal/ui/chat/messages.go

@@ -163,6 +163,10 @@ func GetMessageItems(sty *styles.Styles, msg *message.Message, toolResults map[s
 	return []MessageItem{}
 }
 
+// shouldRenderAssistantMessage determines if an assistant message should be rendered
+//
+// In some cases the assistant message only has tools so we do not want to render an
+// empty message.
 func shouldRenderAssistantMessage(msg *message.Message) bool {
 	content := strings.TrimSpace(msg.Content().Text)
 	thinking := strings.TrimSpace(msg.ReasoningContent().Thinking)

internal/ui/model/ui.go

@@ -384,6 +384,7 @@ func (m *UI) setSessionMessages(msgs []message.Message) tea.Cmd {
 	return tea.Batch(cmds...)
 }
 
+// appendSessionMessage appends a new message to the current session in the chat
 func (m *UI) appendSessionMessage(msg message.Message) tea.Cmd {
 	items := chat.GetMessageItems(m.com.Styles, &msg, nil)
 	var cmds []tea.Cmd
@@ -399,6 +400,8 @@ func (m *UI) appendSessionMessage(msg message.Message) tea.Cmd {
 	return tea.Batch(cmds...)
 }
 
+// updateSessionMessage updates an existing message in the current session in the chat
+// INFO: currently only updates the assistant when I add tools this will get a bit more complex
 func (m *UI) updateSessionMessage(msg message.Message) tea.Cmd {
 	existingItem := m.chat.GetMessageItem(msg.ID)
 	switch msg.Role {