lots more documentation comments

1 files changed, 5 insertions, 2 deletions

diff --git a/gemini/client.go b/gemini/client.go
index 53c8b71..aca4576 100644
--- a/gemini/client.go
+++ b/gemini/client.go
@@ -28,6 +28,9 @@ func NewClient(tlsConf *tls.Config) Client {
 //
 // It also populates the TLSState and RemoteAddr fields on the request - the only field
 // it needs populated beforehand is the URL.
+//
+// This method will not automatically follow redirects or cache permanent failures or
+// redirects.
 func (client Client) RoundTrip(request *Request) (*Response, error) {
 	if request.Scheme != "gemini" && request.Scheme != "" {
 		return nil, errors.New("non-gemini protocols not supported")
@@ -57,8 +60,8 @@ func (client Client) RoundTrip(request *Request) (*Response, error) {
 		return nil, err
 	}
 
-	// read and store the request body in full or we may miss doing so before the
-	// connection gets closed.
+	// read and store the request body in full or we may miss doing so before
+	// closing the connection
 	bodybuf, err := io.ReadAll(response.Body)
 	if err != nil {
 		return nil, err