Skip to content

[spec-librarian] Specification Audit — 2026-07-25 — 1 issue found #48014

Description

@github-actions

📚 Package Specification Audit Report

Date: 2026-07-25
Total Packages: 33
Packages with Specs: 33
Coverage: 100%


Coverage Summary

All 33 packages under pkg/ have a README.md specification. The specifications are auto-maintained by the spec-extractor workflow and are generally comprehensive and up-to-date.


🚨 Missing Specifications

None — all 33 packages have README.md files.


⚠️ Specification Accuracy Issues

View accuracy issue (1 package)

linters — Undocumented Exported Function

  • File: pkg/linters/registry.go
  • Issue: func All() []*analysis.Analyzer is an exported top-level function, but the README appendix reports "Functions and methods: 0" and never mentions All() anywhere in the document.
  • Impact: Callers looking for how to obtain the full analyzer list from the linters package cannot discover this from the specification.
  • Recommendation: Update the linters README to document All() and correct the appendix count from 0 to 1. Re-run the spec-extractor workflow for pkg/linters.

🔄 Cross-Package Inconsistencies

No structural inconsistencies found. Dependency declarations in READMEs match actual Go import graphs for all sampled packages. Terminology is consistent (e.g., all specs use stderr for diagnostic output and stdout for structured machine-readable output).


📊 Quality Scores

Package Completeness Accuracy Consistency Freshness Overall
actionpins 100% 100% 100% 100% ✅ 100%
agentdrain 100% 100% 100% 100% ✅ 100%
cli 95% 95% 95% 100% ✅ 96%
colorwriter 100% 100% 100% 100% ✅ 100%
console 95% 95% 90% 100% ✅ 95%
constants 100% 100% 100% 100% ✅ 100%
envutil 100% 100% 100% 100% ✅ 100%
errorutil 100% 100% 100% 100% ✅ 100%
fileutil 100% 100% 100% 100% ✅ 100%
github 100% 100% 100% 100% ✅ 100%
githubapi 100% 100% 100% 100% ✅ 100%
gitutil 100% 100% 100% 100% ✅ 100%
importinpututil 100% 100% 100% 100% ✅ 100%
intent 100% 100% 100% 100% ✅ 100%
jsonutil 100% 100% 100% 100% ✅ 100%
linters 98% 70% 95% 100% ⚠️ 66% (accuracy penalised by undocumented All())
logger 100% 100% 100% 100% ✅ 100%
modelsdev 100% 100% 100% 100% ✅ 100%
parser 100% 100% 100% 100% ✅ 100%
repoutil 100% 100% 100% 100% ✅ 100%
semverutil 100% 100% 100% 100% ✅ 100%
setutil 100% 100% 100% 100% ✅ 100%
sliceutil 100% 100% 100% 100% ✅ 100%
stats 100% 100% 100% 100% ✅ 100%
stringutil 100% 100% 100% 100% ✅ 100%
styles 100% 100% 100% 100% ✅ 100%
syncutil 100% 100% 100% 100% ✅ 100%
testutil 100% 100% 100% 100% ✅ 100%
timeutil 100% 100% 100% 100% ✅ 100%
tty 100% 100% 100% 100% ✅ 100%
types 100% 100% 100% 100% ✅ 100%
typeutil 100% 100% 100% 100% ✅ 100%
workflow 95% 95% 95% 100% ✅ 95%

Action Items

  • Update pkg/linters/README.md to document func All() []*analysis.Analyzer from registry.go and correct the appendix function count from 0 to 1 (re-run spec-extractor for pkg/linters).
  • When opening a fix PR for this issue, include Closes #<this issue number> (or Fixes/Resolves) in the PR description.

📚 Next review scheduled for tomorrow. Close this issue once all items are resolved.

📚 Specification review by Package Specification Librarian · sonnet46 · 195.3 AIC · ⌖ 7.94 AIC · ⊞ 6.2K ·

  • expires on Jul 28, 2026, 5:54 AM UTC-08:00

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions