aboutsummaryrefslogtreecommitdiff
path: root/object/doc.go
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-29 09:49:21 +0000
committerGravatar Runxi Yu2026-03-29 09:49:21 +0000
commitec658d86dda3ac0e9b63635a4144c432223b9fc8 (patch)
tree8e97122edc90ed45e73de3e192addd8deadc79b1 /object/doc.go
parentobject/stored: Split files and document properly (diff)
object: Split files
Diffstat (limited to 'object/doc.go')
-rw-r--r--object/doc.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/object/doc.go b/object/doc.go
new file mode 100644
index 00000000..f675b963
--- /dev/null
+++ b/object/doc.go
@@ -0,0 +1,7 @@
+// Package object provides the shared [Object] interface and parsing functions
+// for Git object values.
+//
+// Concrete object forms such as [blob], [tree], [commit], and [tag] live in
+// subpackages. Use [codeberg.org/lindenii/furgit/object/stored] when object
+// values need to be paired with the object IDs they were loaded under.
+package object