Repository navigation
[spec-librarian] Specification Audit — 2026-09-22 — 1 issue found #62659
Description
📚 Package Specification Audit Report
Date: 2026-09-22
Total Packages: 36
Packages with Specs: 35
Coverage: 97%
Coverage Summary
All 35 library packages under pkg/ have a README.md. pkg/workflowcontract has no README.md, but it contains zero exported symbols (only workflow-contract regression tests), so it is not flagged as a coverage gap requiring a spec.
| Status | Package | Notes |
|---|---|---|
| ✅ | 34 of 35 spec-covered packages | No documentation gaps found |
errorutil |
One exported function undocumented (see below) | |
| ➖ | workflowcontract |
No README; package exposes 0 exported symbols (test-only contract assertions), so no spec is required |
⚠️ Missing Function Documentation
View details (1 package)
pkg/errorutil — IsNotFoundOutput undocumented
- Location:
pkg/errorutil/errors.go:29 - Signature:
func IsNotFoundOutput(output string) bool - Doc comment in source: "IsNotFoundOutput reports whether output represents an HTTP 404 / not found response."
- Problem: This exported function is not listed in the Public API table of
pkg/errorutil/README.md, which currently documentsIsNotFoundError,IsForbiddenError,IsGoneError,IsRateLimitError,IsAuthError,IsInsufficientScopesError, andIsAlreadyMergedError, but omitsIsNotFoundOutput. - Recommendation: Add a row for
IsNotFoundOutputto the Public API table inpkg/errorutil/README.md, following the existing format, and add a short usage example alongside the other Is* helpers.
Notes on Methodology
- This audit ran in a shallow, single-commit checkout, so git-history-based staleness detection (spec vs. source last-modified dates) was not possible in this run. Once full git history is available in future runs, staleness detection should compare README.md commit dates against non-test .go file commit dates per package.
- Cross-package terminology checks (stdout/stderr conventions, dependency references such as errorutils documented use by pkg/cli and pkg/parser) were verified and found consistent — no conflicts detected.
- No other undocumented or phantom (documented-but-removed) exported symbols were found across the other 34 specified packages during this pass.
Action Items
- Add
IsNotFoundOutputto the Public API table inpkg/errorutil/README.md - When full git history is available, re-run staleness detection comparing README vs. source commit dates
- When opening a fix PR for this issue, include
Closes #<this issue number>(orFixes/Resolves) in the PR description.
📚 Next review scheduled for tomorrow. Close this issue once all items are resolved.
📚 Specification review by Package Specification Librarian · copilot · auto · 108.2 AIC · ⌖ 6.89 AIC · ⊞ 8.8K · ◷
- expires on Sep 25, 2026, 5:32 AM UTC-08:00
Activity
github-actions commentedon Sep 25, 2026
This issue was automatically closed because it expired on 2026-09-25T13:32:08.686Z.