From ec8f5ca3c59c3715b7c0d12dde962d3e4c58403e Mon Sep 17 00:00:00 2001
From: "Babak K. Shandiz" <babakks@github.com>
Date: Mon, 3 Nov 2025 16:02:51 +0000
Subject: [PATCH] docs(pkg/api): explain `HandleHTTPError` does not close resp
 body

Signed-off-by: Babak K. Shandiz <babakks@github.com>
---
 pkg/api/errors.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pkg/api/errors.go b/pkg/api/errors.go
index aaf1642..74e9515 100644
--- a/pkg/api/errors.go
+++ b/pkg/api/errors.go
@@ -98,6 +98,8 @@ func matchPath(p, expect string) bool {
 }
 
 // HandleHTTPError parses a http.Response into a HTTPError.
+//
+// The function attempts to read the response's body, but it does not close it.
 func HandleHTTPError(resp *http.Response) error {
 	httpError := &HTTPError{
 		Headers:    resp.Header,