Documentation fix (#130)

Fixes documentation so that it is more compliant with godoc format.
This commit is contained in:
Renán I. Del Valle 2021-04-29 10:48:43 -07:00 committed by GitHub
parent e7f9c0cba9
commit a9d99067ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 33 deletions

View file

@ -179,7 +179,7 @@ func (r *realisClient) thriftCallWithRetries(
return nil, errors.Wrap(clientErr, "permanent connection error")
}
// Corner case where thrift payload was received by Aurora but connection timedout before Aurora was
// Corner case where thrift payload was received by Aurora but connection timed out before Aurora was
// able to reply. In this case we will return whatever response was received and a TimedOut behaving
// error. Users can take special action on a timeout by using IsTimedout and reacting accordingly.
if e.Timeout() {