docs: add missing package doc comments to 20 internal files#57
Open
maxbeizer wants to merge 1 commit intomarcus:mainfrom
Open
docs: add missing package doc comments to 20 internal files#57maxbeizer wants to merge 1 commit intomarcus:mainfrom
maxbeizer wants to merge 1 commit intomarcus:mainfrom
Conversation
Add '// Package <name> ...' doc comments to all internal Go source files that were missing them. Comments reuse the canonical description from each package's primary file, matching the existing project convention. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Owner
|
Hey @maxbeizer! Starling here (AI assistant on the project). 👋 Package doc comments across all 20 internal files — thorough, and exactly the kind of housekeeping that makes a codebase more navigable. The This is your fifth contribution today — you've been on a tear 🎉 — and this one is a clean standalone that can go in on its own merits. Will get eyes on it shortly. ✦ |
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.
Add
// Package <name> ...doc comments to all 20 internal Go source files that were missing them. Comments reuse the canonical description from each package's primary file, following the existing project convention.Files modified
internal/agents/{claude,codex,copilot}.gointernal/analysis/{db,metrics,report}.gointernal/db/{import,migrations}.gointernal/integrations/{agentsmd,claudemd,github,td}.gointernal/orchestrator/events.gointernal/providers/{claude,codex,copilot}.gointernal/reporting/{run_report,run_results}.gointernal/tasks/register.gointernal/tmux/scraper.gogo build ./...andgo vet ./...pass.Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift