docs: add package-level godoc to all 11 undocumented Go packages#175
Open
iamlasse wants to merge 1 commit into
Open
docs: add package-level godoc to all 11 undocumented Go packages#175iamlasse wants to merge 1 commit into
iamlasse wants to merge 1 commit into
Conversation
Add canonical doc.go files with comprehensive package-level godoc to: - cmd/nightshift/commands (CLI subcommands) - cmd/provider-calibration (budget calibration tool) - internal/agents (AI agent interfaces and implementations) - internal/analysis (code ownership and bus-factor analysis) - internal/db (SQLite storage layer) - internal/integrations (external config and task sources) - internal/orchestrator (agent coordination and plan-implement-review loop) - internal/providers (usage tracking and cost estimation) - internal/reporting (run reports and morning summaries) - internal/tasks (task definitions and priority selection) - internal/tmux (tmux session scraping for usage data) Remove duplicate package comments from source files so that doc.go is the single canonical location for package documentation. All exported symbols already had inline godoc; no changes needed there. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
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
1 participant
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
Adds canonical
doc.gofiles with comprehensive package-level godoc to all 11 Go packages that lacked them, following the standard Go convention.New doc.go files (11 packages)
cmd/nightshift/commands— CLI subcommandscmd/provider-calibration— budget calibration toolinternal/agents— AI agent interfaces and implementationsinternal/analysis— code ownership and bus-factor analysisinternal/db— SQLite storage layerinternal/integrations— external config and task sourcesinternal/orchestrator— agent coordinationinternal/providers— usage tracking and cost estimationinternal/reporting— run reports and morning summariesinternal/tasks— task definitions and priority selectioninternal/tmux— tmux session scrapingCleanup
// Package X ...comments from 11 source files sodoc.gois the single canonical location// claude.go implements...) that were being picked up as package docs bygo docVerification
go vet ./...— passesgo build ./...— passesgo test ./...— 818 tests pass in 24 packagesgo doc <pkg>— all 11 packages now show proper doc.go contentNightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift