From 4d47c2afd7b61ab5201e4a4cb3fbc05e92fd1e1c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?KevinZ=C3=B8nda?=
 <33132228+KevinZonda@users.noreply.github.com>
Date: Thu, 4 May 2023 15:27:54 +0100
Subject: [PATCH] docs: improve ambiguous comment in c.Stream

---
 context.go | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/context.go b/context.go
index 5716318e..ec1a8bfd 100644
--- a/context.go
+++ b/context.go
@@ -1072,7 +1072,9 @@ func (c *Context) SSEvent(name string, message any) {
 }
 
 // Stream sends a streaming response and returns a boolean
-// indicates "Is client disconnected in middle of stream"
+// indicates "Will the client be connected in middle of stream"
+// i.e. if return true, the client will keep connected
+//      if return false, the client will be disconnected
 func (c *Context) Stream(step func(w io.Writer) bool) bool {
 	w := c.Writer
 	clientGone := w.CloseNotify()