docs: close spec-librarian API drift findings across 5 package READMEs#32629
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix Package Specification Librarian failure
docs: close spec-librarian API drift findings across 5 package READMEs
May 16, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates package README specifications to eliminate documented/public API drift across several pkg/* packages so the documented surfaces match the current exported Go symbols.
Changes:
- Added missing exported symbol inventories and sections to
typeutilandstringutilREADMEs. - Documented newly missing exported constants in
constantsand exports inconsole. - Added
osexitinlibrarysubpackage tolintersREADME with usage guidance.
Show a summary per file
| File | Description |
|---|---|
| pkg/typeutil/README.md | Adds an exported-functions inventory covering all current public helpers. |
| pkg/stringutil/README.md | Documents missing exports (NormalizeLeadingWhitespace, FormatList, SanitizeOptions, SanitizeName) and adds an exported-types section. |
| pkg/linters/README.md | Documents the osexitinlibrary analyzer subpackage and includes it in the API/usage sections. |
| pkg/constants/README.md | Adds missing minimum-version constants for AWF feature gating to the documented list. |
| pkg/console/README.md | Adds missing exported items (BannerStyle, SpinnerWrapper) to the public API table. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 5/5 changed files
- Comments generated: 0
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.
The Package Specification Librarian run failed after identifying API drift: 14 exported symbols were present in source but missing from package specs across
typeutil,stringutil,constants,console, andlinters. This PR updates those package READMEs so the documented public surface matches current exports.Type conversion spec completeness (
pkg/typeutil)String utility API completeness (
pkg/stringutil)NormalizeLeadingWhitespace,FormatList,SanitizeOptions, andSanitizeName.SanitizeOptionsdiscoverable.Version-gating constants coverage (
pkg/constants)AWFDockerHostPathPrefixMinVersionAWFTokenSteeringMinVersionConsole public surface alignment (
pkg/console)BannerStyleSpinnerWrapperLinter namespace coverage (
pkg/linters)osexitinlibraryas a documented subpackage and includedosexitinlibrary.Analyzerin usage/API descriptions.