Package Specification Audit Report
Date: 2026-08-19
Total Packages: 34
Packages with Specs: 34
Coverage: 100%
All 34 packages under pkg/ have a README.md specification. No missing specifications were found. Note: this checkout is a single-commit shallow clone, so git-history staleness could not be computed; staleness was instead assessed by cross-referencing documented symbols against current source.
Phantom functions in pkg/workflow/README.md
The Permissions Factory table documents two functions that do NOT exist in pkg/workflow/permissions_factory.go:
- NewPermissionsContentsReadIssuesWriteDiscussionsWrite()
- NewPermissionsContentsReadProjectsWrite()
Actual exported factory functions include NewPermissionsContentsReadIssuesWrite, NewPermissionsContentsReadDiscussionsWrite, NewPermissionsContentsReadPRWrite, NewPermissionsContentsReadSecurityEventsWrite, NewPermissionsIssuesWriteDiscussionsWrite, NewPermissionsOrganizationProjWrite, NewPermissionsOrganizationProjWriteIssuesRead -- but no combined contents-read+issues-write+discussions-write or contents-read+projects-write constructors exist.
Recommendation: Update the Permissions Factory table in pkg/workflow/README.md to remove the two phantom rows, or add the corresponding factory functions to pkg/workflow/permissions_factory.go if genuinely needed. Also check whether NewPermissionsIssuesWriteDiscussionsWrite / NewPermissionsOrganizationProjWrite were meant to be documented there instead.
Documentation completeness (informational)
Exported-function-vs-README cross reference shows most packages document a focused subset of their exported API rather than every symbol (e.g. stringutil 28/112, console 78/238, workflow 567/6308). This appears to be an intentional focused-API documentation style, not flagged as a defect.
Action Items
- Fix the two phantom function references in pkg/workflow/README.md Permissions Factory table (remove or implement NewPermissionsContentsReadIssuesWriteDiscussionsWrite and NewPermissionsContentsReadProjectsWrite)
- When opening a fix PR for this issue, include Closes #(this issue number) in the PR description.
Next review scheduled for tomorrow. Close this issue once all items are resolved.
📚 Specification review by Package Specification Librarian · auto · 60 AIC · ⌖ 2.3 AIC · ⊞ 8.9K · ◷
Package Specification Audit Report
Date: 2026-08-19
Total Packages: 34
Packages with Specs: 34
Coverage: 100%
All 34 packages under pkg/ have a README.md specification. No missing specifications were found. Note: this checkout is a single-commit shallow clone, so git-history staleness could not be computed; staleness was instead assessed by cross-referencing documented symbols against current source.
Phantom functions in pkg/workflow/README.md
The Permissions Factory table documents two functions that do NOT exist in pkg/workflow/permissions_factory.go:
Actual exported factory functions include NewPermissionsContentsReadIssuesWrite, NewPermissionsContentsReadDiscussionsWrite, NewPermissionsContentsReadPRWrite, NewPermissionsContentsReadSecurityEventsWrite, NewPermissionsIssuesWriteDiscussionsWrite, NewPermissionsOrganizationProjWrite, NewPermissionsOrganizationProjWriteIssuesRead -- but no combined contents-read+issues-write+discussions-write or contents-read+projects-write constructors exist.
Recommendation: Update the Permissions Factory table in pkg/workflow/README.md to remove the two phantom rows, or add the corresponding factory functions to pkg/workflow/permissions_factory.go if genuinely needed. Also check whether NewPermissionsIssuesWriteDiscussionsWrite / NewPermissionsOrganizationProjWrite were meant to be documented there instead.
Documentation completeness (informational)
Exported-function-vs-README cross reference shows most packages document a focused subset of their exported API rather than every symbol (e.g. stringutil 28/112, console 78/238, workflow 567/6308). This appears to be an intentional focused-API documentation style, not flagged as a defect.
Action Items
Next review scheduled for tomorrow. Close this issue once all items are resolved.