git.iko.soy/crush
on main help sign in
docs: add some package-level GoDoc comments

Co-authored-by: Justin Johnson <jeepinbird@gmail.com>

commitc84de0507c42395836e2b9798bd4b04288ff9f9b authorChristian Rocha <christian@rocha.is> dateSun 2 Nov 2025, 09:26 (1 year ago) parent06a77d6
3 files changed+11−2
compare with main
unifiedsplit
CRUSH.md+1−1 internal/agent/agent.go+8−1 internal/app/app.go+2
CRUSH.md+1−1
@@ -62,7 +62,7 @@ func TestYourFunction(t *testing.T) {
6262
6363## Comments
6464
65−- Comments that live one their own lines should start with capital letters and
65+- Comments that live on their own lines should start with capital letters and
6666 end with periods. Wrap comments at 78 columns.
6767
6868## Committing
internal/agent/agent.go+8−1
@@ -1,3 +1,10 @@
1+// Package agent is the core orchestration layer for Crush AI agents.
2+//
3+// It provides session-based AI agent functionality for managing
4+// conversations, tool execution, and message handling. It coordinates
5+// interactions between language models, messages, sessions, and tools while
6+// handling features like automatic summarization, queuing, and token
7+// management.
18package agent
29
310import (
@@ -131,7 +138,7 @@ func (a *sessionAgent) Run(ctx context.Context, call SessionAgentCall) (*fantasy
131138 }
132139
133140 if len(a.tools) > 0 {
134− // Add anthropic caching to the last tool.
141+ // Add Anthropic caching to the last tool.
135142 a.tools[len(a.tools)-1].SetProviderOptions(a.getCacheControlOptions())
136143 }
137144
internal/app/app.go+2
@@ -1,3 +1,5 @@
1+// Package app wires together services, coordinates agents, and manages
2+// application lifecycle.
13package app
24
35import (