From 383fea147737091d4ba3e3f6ec33880b280bb4d4 Mon Sep 17 00:00:00 2001 From: nux Date: Mon, 19 Jan 2026 08:58:53 +0000 Subject: [PATCH 1/2] docs: add comment explaining beads.New() as main entry point Task 36: Added a brief comment explaining that New() is the main entry point for interacting with the beads CLI programmatically. Co-Authored-By: Claude Opus 4.5 --- internal/beads/beads.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/internal/beads/beads.go b/internal/beads/beads.go index 70f90c1d4f..2afd48078c 100644 --- a/internal/beads/beads.go +++ b/internal/beads/beads.go @@ -117,6 +117,8 @@ type Beads struct { } // New creates a new Beads wrapper for the given directory. +// This is the main entry point for interacting with the beads CLI programmatically. +// The workDir should be a directory containing or inheriting a .beads database. func New(workDir string) *Beads { return &Beads{workDir: workDir} } From 0cededda4ac98a8abba4e1ac9406ec256d26f783 Mon Sep 17 00:00:00 2001 From: nux Date: Mon, 19 Jan 2026 09:08:11 +0000 Subject: [PATCH 2/2] docs: enhance package comment in internal/beads/beads.go (gt-bi7nb) Add usage guidance to package-level comment explaining the primary entry point (New()) and key methods for managing beads issues. Co-Authored-By: Claude Opus 4.5 --- internal/beads/beads.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/internal/beads/beads.go b/internal/beads/beads.go index 2afd48078c..1dc6d9b081 100644 --- a/internal/beads/beads.go +++ b/internal/beads/beads.go @@ -1,4 +1,6 @@ // Package beads provides a wrapper for the bd (beads) CLI. +// Use New() to create a Beads instance for a working directory, then call +// methods like List(), Show(), Create(), Update(), and Close() to manage issues. package beads import (