From b0b736350062d61f30b247294ce92c0ac888c06a Mon Sep 17 00:00:00 2001 From: Gavriel Hirsch Date: Tue, 10 May 2022 10:29:36 -0700 Subject: [PATCH] PR feedback --- client.go | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/client.go b/client.go index e75b649..f40d241 100644 --- a/client.go +++ b/client.go @@ -80,11 +80,15 @@ var ( type ReaderFunc func() (io.Reader, error) // ResponseHandlerFunc is a type of function that takes in a Response, and does something with it. -// If an error is returned, the client's retry policy will be used to determine +// The ResponseHandlerFunc is called when the HTTP client successfully receives a response and the +// CheckRetry function indicates that a retry of the base request is not necessary. +// If an error is returned from this function, the CheckRetry policy will be used to determine // whether to retry the whole request (including this handler). -// NOTE: It only runs if the initial part of the request was successful. -// Make sure to check status codes! Even if the request was "successful" it may have a non-2xx status code. -// NOTE: If there is a response body, users should make sure to close it to avoid a memory leak. +// +// Make sure to check status codes! Even if the request was completed it may have a non-2xx status code. +// +// The response body is not automatically closed. It must be closed either by the ResponseHandlerFunc or +// by the caller out-of-band. Failure to do so will result in a memory leak. type ResponseHandlerFunc func(*http.Response) error // LenReader is an interface implemented by many in-memory io.Reader's. Used