From 781f6c5d228c34227dcd059673175ea86398218f Mon Sep 17 00:00:00 2001
From: Ethan Buchman <ethan@coinculture.info>
Date: Tue, 12 Dec 2017 18:04:05 -0500
Subject: [PATCH] db: some comments in types.go

---
 db/types.go | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/db/types.go b/db/types.go
index 8306813c..a6edbdd8 100644
--- a/db/types.go
+++ b/db/types.go
@@ -54,10 +54,12 @@ type SetDeleter interface {
 
 //----------------------------------------
 
+// BeginningKey is the smallest key.
 func BeginningKey() []byte {
 	return []byte{}
 }
 
+// EndingKey is the largest key.
 func EndingKey() []byte {
 	return nil
 }
@@ -81,8 +83,8 @@ type Iterator interface {
 	// A domain of ([]byte{12, 13}, []byte{12, 14}) will iterate
 	// over anything with the prefix []byte{12, 13}.
 	//
-	// The smallest key is the empty byte array []byte{}.
-	// The largest key is the nil byte array []byte(nil).
+	// The smallest key is the empty byte array []byte{} - see BeginningKey().
+	// The largest key is the nil byte array []byte(nil) - see EndingKey().
 	Domain() (start []byte, end []byte)
 
 	// Valid returns whether the current position is valid.
@@ -100,7 +102,7 @@ type Iterator interface {
 	// If Valid returns false, this method will panic.
 	Key() []byte
 
-	// Value returns the key of the cursor.
+	// Value returns the value of the cursor.
 	//
 	// If Valid returns false, this method will panic.
 	Value() []byte