Updated README to document WSRetries

This commit is contained in:
diamondburned (Forefront) 2020-03-18 22:00:05 -07:00
parent b59d9bfed7
commit 126ab255cd
1 changed files with 4 additions and 2 deletions

View File

@ -67,8 +67,10 @@ things in the state, which is useful for keeping it updated.
- ~~The bot will fatally exit if it fails to reconnect to the Gateway after a
certain amount of times. This is changeable in `gateway.WSFatal`, or
`(*Gateway).FatalLog`.~~
- The bot will error out if the initial connection fails. However, reconnections
will be retried forever until it succeeds.
- ~~The bot will error out if the initial connection fails. However,
reconnections will be retried forever until it succeeds.~~ This is no longer
true. The bot will retry until `WSRetries` is reached, then the error will go
to `(*Gateway).FatalError` or `(*Gateway).Wait()`.
## Testing