aboutsummaryrefslogtreecommitdiff
path: root/ref
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-29 09:52:54 +0000
committerGravatar Runxi Yu2026-03-29 09:52:54 +0000
commitd9b6bfb4869058eba83173760b5a916ffa3a5b65 (patch)
tree90236d2d9504b6b9756f4eda41c0c79c14b557fb /ref
parentobject: Split files (diff)
signatureNo signature
ref: Update docs
Diffstat (limited to 'ref')
-rw-r--r--ref/doc.go5
-rw-r--r--ref/ref.go1
2 files changed, 5 insertions, 1 deletions
diff --git a/ref/doc.go b/ref/doc.go
new file mode 100644
index 00000000..610c3013
--- /dev/null
+++ b/ref/doc.go
@@ -0,0 +1,5 @@
+// Package ref provides Git reference values.
+//
+// A reference is either [Detached], which points directly to an object ID, or
+// [Symbolic], which points to another reference name.
+package ref
diff --git a/ref/ref.go b/ref/ref.go
index 51f4d764..0c70cc26 100644
--- a/ref/ref.go
+++ b/ref/ref.go
@@ -1,4 +1,3 @@
-// Package ref provides general, detached, and symbolic references.
package ref
// Ref is a Git reference.