Add function comment.

Amnesic-Systems · Nov 22, 2024 · e8120e9 · e8120e9
1 parent aa8af19
commit e8120e9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/internal/httpx/httpx.go b/internal/httpx/httpx.go
@@ -75,6 +75,10 @@ func NewUnauthClient() *http.Client {
 	}
 }
 
+// WaitForSvc waits for the service (specified by the URL) to become available
+// by making repeated HTTP GET requests using the given HTTP client.  This
+// function blocks until 1) the service responds with an HTTP response or 2) the
+// given context expires.
 func WaitForSvc(
 	ctx context.Context,
 	client *http.Client,