docs(beads): enhance package comment with usage guidance#27
Closed
julianknutsen wants to merge 2 commits intomainfrom
Closed
docs(beads): enhance package comment with usage guidance#27julianknutsen wants to merge 2 commits intomainfrom
julianknutsen wants to merge 2 commits intomainfrom
Conversation
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 <noreply@anthropic.com>
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 <noreply@anthropic.com>
Code Coverage ReportOverall Coverage: 20.3%
Generated by CI |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enhanced the package comment in
internal/beads/beads.goto include usage guidance, explaining the primary entry point (New()) and key methods for managing beads issues.Related Issue
Relates to gt-bi7nb
Changes
New()function as the main entry pointList(),Show(),Create(),Update(), andClose()Testing
go test ./internal/beads/...)go build ./...)Checklist