From d585f0889eef41f1386abefe3daa2e617a21895e Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Wed, 4 Mar 2026 14:31:38 +0800 Subject: *: Add package-level docs --- cmd/show-object/main.go | 1 + format/doc.go | 2 ++ internal/adler32/doc.go | 2 ++ reachability/reachability.go | 1 + 4 files changed, 6 insertions(+) create mode 100644 format/doc.go create mode 100644 internal/adler32/doc.go diff --git a/cmd/show-object/main.go b/cmd/show-object/main.go index b3f5a9cd..94978db6 100644 --- a/cmd/show-object/main.go +++ b/cmd/show-object/main.go @@ -1,3 +1,4 @@ +// Command show-object provides a small command line utility to show the details of a specified Git object. package main import ( diff --git a/format/doc.go b/format/doc.go new file mode 100644 index 00000000..d84b09e5 --- /dev/null +++ b/format/doc.go @@ -0,0 +1,2 @@ +// Package format encapsulates constants and general-purpose routines for Git-related formats. +package format diff --git a/internal/adler32/doc.go b/internal/adler32/doc.go new file mode 100644 index 00000000..add30867 --- /dev/null +++ b/internal/adler32/doc.go @@ -0,0 +1,2 @@ +// Package adler32 implements an SIMD-optimized Adler-32 checksum. +package adler32 diff --git a/reachability/reachability.go b/reachability/reachability.go index 93bc840b..12f672e3 100644 --- a/reachability/reachability.go +++ b/reachability/reachability.go @@ -1,3 +1,4 @@ +// Package reachability traverses the object graph to test relationships and emit object lists. package reachability import ( -- cgit v1.3.1-10-gc9f91