Merge pull request #29 from benbjohnson/cleanup

API Documentation

1 files changed, 5 insertions, 0 deletions

diff --git a/bucket.go b/bucket.go
index 28c570e..414d260 100644
--- a/bucket.go
+++ b/bucket.go
@@ -1,11 +1,16 @@
 package bolt
 
+// Bucket represents a collection of key/value pairs inside the database.
+// All keys inside the bucket are unique. The Bucket type is not typically used
+// directly. Instead the bucket name is typically passed into the Get(), Put(),
+// or Delete() functions.
 type Bucket struct {
 	*bucket
 	name        string
 	transaction *Transaction
 }
 
+// bucket represents the on-file representation of a bucket.
 type bucket struct {
 	root pgid
 }