Merge pull request #559 from rackspace/comment-about-reauth
comment about limiting the number of re-auth attempts
diff --git a/auth_options.go b/auth_options.go
index d26e16a..07ace13 100644
--- a/auth_options.go
+++ b/auth_options.go
@@ -42,6 +42,11 @@
// re-authenticate automatically if/when your token expires. If you set it to
// false, it will not cache these settings, but re-authentication will not be
// possible. This setting defaults to false.
+ //
+ // NOTE: The reauth function will try to re-authenticate endlessly if left unchecked.
+ // The way to limit the number of attempts is to provide a custom HTTP client to the provider client
+ // and provide a transport that implements the RoundTripper interface and stores the number of failed retries.
+ // For an example of this, see here: https://github.com/rackspace/rack/blob/1.0.0/auth/clients.go#L311
AllowReauth bool
// TokenID allows users to authenticate (possibly as another user) with an