summaryrefslogtreecommitdiff
path: root/spartan
diff options
context:
space:
mode:
authortjpcc <tjp@ctrl-c.club>2023-08-12 08:48:11 -0600
committertjpcc <tjp@ctrl-c.club>2023-08-12 08:48:11 -0600
commitbb4bbc5659a506533eb2d45f102ea394e050cee2 (patch)
tree8bd04a56c6f3b2869111a5703a0d62eef4b9d35f /spartan
parentb423ed96c71bdd1cdecc4129a26d2dbcaa91dafe (diff)
document maxredirects on clients
Diffstat (limited to 'spartan')
-rw-r--r--spartan/client.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/spartan/client.go b/spartan/client.go
index a98949d..9547f74 100644
--- a/spartan/client.go
+++ b/spartan/client.go
@@ -15,11 +15,12 @@ import (
//
// It carries no state and is reusable simultaneously by multiple goroutines.
//
-// The zero value is immediately usabble.
+// The zero value is immediately usabble, but will not follow redirects.
type Client struct{
MaxRedirects int
}
+// NewClient creates a spartan Client which will follow DefaultMaxRedirects.
func NewClient() Client {
return Client{MaxRedirects: DefaultMaxRedirects}
}