add docs for ErrDBClosed and IteratorError (#47)

jmhodges · Oct 19, 2019 · be6654e · be6654e
1 parent 4f85f57
commit be6654e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/db.go b/db.go
@@ -36,6 +36,7 @@ func (e DatabaseError) Error() string {
 	return "levigo: " + string(e)
 }
 
+// ErrDBClosed is returned by DB.Close when its been called previously.
 var ErrDBClosed = errors.New("database is closed")
 
 // DB is a reusable handle to a LevelDB database on disk, created by Open.

diff --git a/iterator.go b/iterator.go
@@ -9,6 +9,7 @@ import (
 	"unsafe"
 )
 
+// IteratorError wraps general internal LevelDB iterator errors for user consumption.
 type IteratorError string
 
 func (e IteratorError) Error() string {