chore: Add package descriptions

gchkhikvadze · Oct 24, 2022 · 90a5ce5 · 90a5ce5
1 parent 2d6e3a4
commit 90a5ce5
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/.golangci.yml b/.golangci.yml
@@ -134,7 +134,6 @@ linters-settings:
   stylecheck:
     checks:
     - all
-    - -ST1000
 
 issues:
   include:

diff --git a/assets/chezmoi.io/docs/docs.go b/assets/chezmoi.io/docs/docs.go
@@ -1,3 +1,4 @@
+// Package docs contains chezmoi's documentation.
 package docs
 
 import _ "embed"

diff --git a/pkg/archivetest/archivetest.go b/pkg/archivetest/archivetest.go
@@ -1,3 +1,4 @@
+// Package archivetest provides useful functions for testing archives.
 package archivetest
 
 import (

diff --git a/pkg/chezmoibubbles/chezmoibubbles.go b/pkg/chezmoibubbles/chezmoibubbles.go
@@ -0,0 +1,3 @@
+// Package chezmoibubbles provides text user interface components for chezmoi
+// using github.com/charmbracelet/bubbletea.
+package chezmoibubbles