From a3226897f09aa3ffe5e43c123054f67f4e5109dc Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Mon, 13 May 2013 02:19:57 -0500 Subject: [PATCH] Update package overview Errors section. Now that all errors are either underlying IO errors or of type MessageError, update the package overview documentation accordingly. --- doc.go | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/doc.go b/doc.go index 84175720..e33528a8 100644 --- a/doc.go +++ b/doc.go @@ -140,12 +140,11 @@ from a remote peer is: Errors -Most errors returned by this package are either the raw errors provided by -underlying calls to read/write from streams, or raw strings that describe -the error. See the documentation of each function for any exceptions. NOTE: -This is currently undergoing change to return errors of type MessageError for -issues which are not io related so the caller can differentiate between -general io errors and malformed messages. +Errors returned by this package are either the raw errors provided by underlying +calls to read/write from streams such as io.EOF, io.ErrUnexpectedEOF, and +io.ErrShortWrite, or of type btcwire.MessageError. This allows the caller to +differentiate between general IO errors and malformed messages through type +assertions. Bitcoin Improvement Proposals