Skip to content

Commit 1938518

Browse files
authored
Cleanup package docs so they show up in pkg.go.dev (#62)
1 parent b2d2507 commit 1938518

File tree

16 files changed

+31
-4
lines changed

16 files changed

+31
-4
lines changed

collections/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package collections contains helper functions for interacting with collection structs like Slices and Maps.
2+
package collections

entrypoint/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package entrypoint contains helper functions for setting up a urfave/cli application that can be used as the CLI
2+
// entrypoint.
3+
package entrypoint

errors/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package errors contains helper functions for returning errors from a CLI.
2+
package errors

files/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package files contains helper functions related to the file system.
2+
package files

lock/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package lock contains helper functions for maintaining a lock table and utilizing it to guard critical sections in
2+
// the code.
3+
package lock

logging/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package logging contains helper functions for setting up a CLI wide logger that can be used to log output at various
2+
// levels.
3+
package logging

random/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package random provides utilities and functions for generating random data.
2+
package random

random/random.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// Package random provides utilities and functions for generating random data.
21
package random
32

43
import (

retry/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package retry contains helper functions that allow you to retry functions on error.
2+
package retry

shell/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package shell contains helper functions for starting and interacting with subprocesses.
2+
package shell

0 commit comments

Comments
 (0)