From 771884bc160b28a3a21ec6210680315defd5bccd Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Fri, 6 Mar 2026 01:26:51 +0800 Subject: *: Add some more package-level docs --- cmd/doc.go | 2 ++ format/delta/doc.go | 2 ++ internal/compress/doc.go | 1 - internal/compress/internal/doc.go | 2 ++ internal/compress/internal/le/le.go | 1 + 5 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 cmd/doc.go create mode 100644 format/delta/doc.go create mode 100644 internal/compress/internal/doc.go diff --git a/cmd/doc.go b/cmd/doc.go new file mode 100644 index 00000000..cdc58288 --- /dev/null +++ b/cmd/doc.go @@ -0,0 +1,2 @@ +// Package cmd encapsulates various commands provided by this module. +package cmd diff --git a/format/delta/doc.go b/format/delta/doc.go new file mode 100644 index 00000000..f63c96a8 --- /dev/null +++ b/format/delta/doc.go @@ -0,0 +1,2 @@ +// Package delta provides various routines to handle Git delta compression. +package delta diff --git a/internal/compress/doc.go b/internal/compress/doc.go index dbc7fd23..5fcda97f 100644 --- a/internal/compress/doc.go +++ b/internal/compress/doc.go @@ -1,3 +1,2 @@ // Package compress encapsulates custom compression algorithms. - package compress diff --git a/internal/compress/internal/doc.go b/internal/compress/internal/doc.go new file mode 100644 index 00000000..b28bad09 --- /dev/null +++ b/internal/compress/internal/doc.go @@ -0,0 +1,2 @@ +// Package internal provides utilities internal to the compression library. +package internal diff --git a/internal/compress/internal/le/le.go b/internal/compress/internal/le/le.go index e54909e1..890ba873 100644 --- a/internal/compress/internal/le/le.go +++ b/internal/compress/internal/le/le.go @@ -1,3 +1,4 @@ +// Package le provides fast little endian integer routines. package le type Indexer interface { -- cgit v1.3.1-10-gc9f91