Skip to content

Commit c655552

Browse files
author
capable
committed
docs: enhance package comment for internal/beads package (gt-bi7nb)
Add comprehensive package documentation explaining the beads package purpose, main types, and constructor functions.
1 parent 9b2a1c4 commit c655552

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

internal/beads/beads.go

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
// Package beads provides a wrapper for the bd (beads) CLI.
1+
// Package beads provides a Go wrapper for the bd (beads) CLI tool.
2+
//
3+
// The beads package enables Gas Town components to interact with the beads
4+
// issue tracking system programmatically. It wraps the bd CLI commands and
5+
// provides typed Go interfaces for common operations like listing issues,
6+
// creating/updating issues, managing dependencies, and syncing with remote.
7+
//
8+
// The main type is [Beads], which is constructed with a working directory
9+
// and provides methods for all bd operations. Use [New] for normal usage,
10+
// [NewIsolated] for test isolation, or [NewWithBeadsDir] when accessing
11+
// beads from a different directory than the working directory.
212
package beads
313

414
import (

0 commit comments

Comments
 (0)