From 1e92d8e08a7cecb105634127136ce9909a720527 Mon Sep 17 00:00:00 2001
From: c9s <yoan@maicoin.com>
Date: Fri, 21 Jan 2022 00:47:28 +0800
Subject: [PATCH] interact: add doc comment to generateTextInputModalRequest

---
 pkg/interact/slack.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pkg/interact/slack.go b/pkg/interact/slack.go
index 9612d41ee..769a9d215 100644
--- a/pkg/interact/slack.go
+++ b/pkg/interact/slack.go
@@ -328,6 +328,8 @@ func (s *Slack) Start(ctx context.Context) {
 	}
 }
 
+// generateTextInputModalRequest generates a general slack modal view request with the given text fields
+// see also https://api.slack.com/surfaces/modals/using#opening
 func generateTextInputModalRequest(title string, prompt string, textFields ...TextField) *slack.ModalViewRequest {
 	// create a ModalViewRequest with a header and two inputs
 	titleText := slack.NewTextBlockObject("plain_text", title, false, false)