Merge pull request #202 from cli/babakks/explain-resp-body-close

babakks · web-flow · commit 15856030a6ac · 2025-11-03T16:07:42.000Z
docs(pkg/api): explain `HandleHTTPError` does not close response body
diff --git 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,

Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,8 @@ func matchPath(p, expect string) bool {`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`// HandleHTTPError parses a http.Response into a HTTPError.`
	`101`	`+//`
	`102`	`+// The function attempts to read the response's body, but it does not close it.`
`101`	`103`	`func HandleHTTPError(resp *http.Response) error {`
`102`	`104`	`httpError := &HTTPError{`
`103`	`105`	`Headers: resp.Header,`