Update package overview Errors section.
Now that all errors are either underlying IO errors or of type MessageError, update the package overview documentation accordingly.
This commit is contained in:
parent
5b78dee7e1
commit
a3226897f0
1 changed files with 5 additions and 6 deletions
11
doc.go
11
doc.go
|
@ -140,12 +140,11 @@ from a remote peer is:
|
||||||
|
|
||||||
Errors
|
Errors
|
||||||
|
|
||||||
Most errors returned by this package are either the raw errors provided by
|
Errors returned by this package are either the raw errors provided by underlying
|
||||||
underlying calls to read/write from streams, or raw strings that describe
|
calls to read/write from streams such as io.EOF, io.ErrUnexpectedEOF, and
|
||||||
the error. See the documentation of each function for any exceptions. NOTE:
|
io.ErrShortWrite, or of type btcwire.MessageError. This allows the caller to
|
||||||
This is currently undergoing change to return errors of type MessageError for
|
differentiate between general IO errors and malformed messages through type
|
||||||
issues which are not io related so the caller can differentiate between
|
assertions.
|
||||||
general io errors and malformed messages.
|
|
||||||
|
|
||||||
Bitcoin Improvement Proposals
|
Bitcoin Improvement Proposals
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue