aboutsummaryrefslogtreecommitdiffstats
path: root/plumbing/object/object.go
diff options
context:
space:
mode:
Diffstat (limited to 'plumbing/object/object.go')
-rw-r--r--plumbing/object/object.go7
1 files changed, 5 insertions, 2 deletions
diff --git a/plumbing/object/object.go b/plumbing/object/object.go
index 51d9bc4..5512932 100644
--- a/plumbing/object/object.go
+++ b/plumbing/object/object.go
@@ -1,3 +1,5 @@
+// Package object contains implementations of all Git objects and utility
+// functions to work with them.
package object
import (
@@ -35,8 +37,9 @@ var ErrUnsupportedObject = errors.New("unsupported object type")
// }
// }
//
-// This interface is intentionally different from plumbing.EncodedObject, which is a lower
-// level interface used by storage implementations to read and write objects.
+// This interface is intentionally different from plumbing.EncodedObject, which
+// is a lower level interface used by storage implementations to read and write
+// objects in its encoded form.
type Object interface {
ID() plumbing.Hash
Type() plumbing.ObjectType