ref: Note that the Peeled field is optional

1 files changed, 3 insertions, 0 deletions

diff --git a/ref/ref.go b/ref/ref.go
index 9d1fbfc2..28b90ae6 100644
--- a/ref/ref.go
+++ b/ref/ref.go
@@ -17,6 +17,9 @@ type Detached struct {
 	ID      objectid.ObjectID
 
 	// Peeled is the peeled target when available (for annotated tags).
+	//
+	// This field is optional backend-provided metadata. Backends that do not
+	// have peel metadata available may leave it nil.
 	Peeled *objectid.ObjectID
 }