Skip to content
This repository has been archived by the owner on May 1, 2020. It is now read-only.

Commit

Permalink
Fix incorrect documentation
Browse files Browse the repository at this point in the history
Fix outdated error type name from "ErrReq" to "ErrRequest"
  • Loading branch information
romshark committed Dec 10, 2018
1 parent de47157 commit e090641
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions interfaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ type ServerImplementation interface {
// client. It must return either a response payload or an error. The
// invocation of OnRequest is potentially concurrent.
//
// A webwire.ErrReq error can be returned to reply with an error code and an
// error message, this is useful when the clients user code needs to be able
// to understand the error and react accordingly. If a non-webwire error
// type is returned such as an error created by fmt.Errorf() then a special
// kind of error (internal server error) is returned to the client as a
// reply, in this case the error will be logged and the error message will
// not be sent to the client for security reasons as this might accidentally
// leak sensitive information to the client.
// A webwire.ErrRequest error can be returned to reply with an error code
// and an error message, this is useful when the clients user code needs to
// be able to understand the error and react accordingly. If a non-webwire
// error type is returned such as an error created by fmt.Errorf() then a
// special kind of error (internal server error) is returned to the client
// as a reply, in this case the error will be logged and the error message
// will not be sent to the client for security reasons as this might
// accidentally leak sensitive information to the client.
//
// BEWARE: The byte-slice returned by message.Payload() references a
// potentially pooled buffer that's reused by another handler goroutine as
Expand Down

0 comments on commit e090641

Please sign in to comment.