From e4afe122f6e0c3159969402e7a3ec47f56d36abd Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 29 Mar 2026 10:06:49 +0000 Subject: object/{id,header,signature,type}: Update docs --- object/header/doc.go | 3 +++ object/header/parse.go | 1 - object/id/doc.go | 2 ++ object/id/objectid.go | 1 - object/signature/signature.go | 2 +- object/type/objecttype.go | 2 +- 6 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 object/header/doc.go create mode 100644 object/id/doc.go diff --git a/object/header/doc.go b/object/header/doc.go new file mode 100644 index 00000000..9c953ebb --- /dev/null +++ b/object/header/doc.go @@ -0,0 +1,3 @@ +// Package objectheader parses and serializes loose-object headers +// ("type size\x00"). +package objectheader diff --git a/object/header/parse.go b/object/header/parse.go index 3751cafc..61678baf 100644 --- a/object/header/parse.go +++ b/object/header/parse.go @@ -1,4 +1,3 @@ -// Package objectheader parses and serializes object headers ("type size\0"). package objectheader import ( diff --git a/object/id/doc.go b/object/id/doc.go new file mode 100644 index 00000000..1436535d --- /dev/null +++ b/object/id/doc.go @@ -0,0 +1,2 @@ +// Package objectid provides Git object IDs and object-ID hash algorithms. +package objectid diff --git a/object/id/objectid.go b/object/id/objectid.go index 8eb82969..301eb8e6 100644 --- a/object/id/objectid.go +++ b/object/id/objectid.go @@ -1,4 +1,3 @@ -// Package objectid provides utilities around object IDs and hash algorithms. package objectid import ( diff --git a/object/signature/signature.go b/object/signature/signature.go index 22e516f9..bd8b8d87 100644 --- a/object/signature/signature.go +++ b/object/signature/signature.go @@ -1,4 +1,4 @@ -// Package signature provides routines and representations that implement author/committer/tagger signatures. +// Package signature provides Git author, committer, and tagger signatures. package signature // Signature represents a Git signature (author/committer/tagger). diff --git a/object/type/objecttype.go b/object/type/objecttype.go index 2e12dadc..18e0ac35 100644 --- a/object/type/objecttype.go +++ b/object/type/objecttype.go @@ -1,4 +1,4 @@ -// Package objecttype provides object type constants and names. +// Package objecttype provides Git object type tags and names. package objecttype // Type mirrors Git object type tags in packfiles. -- cgit v1.3.1-10-gc9f91