Document missing exported APIs across package specs (stringutil, typeutil, constants, console, linters)#32626
Closed
Copilot wants to merge 3 commits into
Closed
Document missing exported APIs across package specs (stringutil, typeutil, constants, console, linters)#32626Copilot wants to merge 3 commits into
Copilot wants to merge 3 commits into
Conversation
6 tasks
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/37a6aa45-525e-43b4-a3e6-943c56c968b4 Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/37a6aa45-525e-43b4-a3e6-943c56c968b4 Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix undocumented exports in package specifications
Document missing exported APIs across package specs (stringutil, typeutil, constants, console, linters)
May 16, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates multiple pkg/* package specifications (READMEs) to eliminate spec drift by documenting currently-exported public APIs that were previously missing from the package docs.
Changes:
- Added documentation for missing exported helpers in
pkg/typeutil(LookupMap,LookupString,LookupStringPath) andpkg/stringutil(FormatList,NormalizeLeadingWhitespace,SanitizeOptions,SanitizeName). - Expanded specs for
pkg/linters,pkg/constants, andpkg/consoleto include newly identified exported symbols/subpackages (e.g.,osexitinlibrary, new min-version constants,BannerStyle,SpinnerWrapper).
Show a summary per file
| File | Description |
|---|---|
| pkg/typeutil/README.md | Documents exported nested-map/string lookup helpers and adds selection guidance. |
| pkg/stringutil/README.md | Documents additional exported string helpers and sanitization types/functions. |
| pkg/linters/README.md | Adds osexitinlibrary to the documented analyzer set and usage example. |
| pkg/constants/README.md | Adds missing minimum-version constraint constants to the spec list. |
| pkg/console/README.md | Expands the documented public API surface to include BannerStyle and SpinnerWrapper. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (1)
pkg/console/README.md:813
- This section documents
BannerStylewithout mentioning that it’s not part of the js/wasm build (seepkg/console/banner.govspkg/console/banner_wasm.go). Please clarify the build target(s) whereBannerStyleis available so the spec matches the conditional API surface.
### `BannerStyle`
`BannerStyle` is the exported Lip Gloss style used by `FormatBanner` for consistent banner rendering.
- Files reviewed: 5/5 changed files
- Comments generated: 1
| | `FormatError` | func | Renders a structured `CompilerError` with context | | ||
| | `FormatErrorChain` | func | Renders a wrapped-error chain | | ||
| | `FormatErrorWithSuggestions` | func | Error message with actionable suggestions | | ||
| | `BannerStyle` | var | Reusable Lip Gloss style used for rendering the ASCII `gh aw` banner | |
Collaborator
|
@copilot review all comments |
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 spec audit found API drift: 5
pkg/*READMEs were missing documentation for currently exported symbols. This PR updates package specifications to align documented public APIs with actual exports.pkg/stringutilNormalizeLeadingWhitespaceFormatListSanitizeOptionsSanitizeNamepkg/typeutilLookupMapLookupStringLookupStringPathpkg/constantsAWFDockerHostPathPrefixMinVersionAWFTokenSteeringMinVersionpkg/consoleBannerStyle(exported style var)SpinnerWrapper(exported spinner type + method surface)pkg/lintersosexitinlibrarysubpackage to the documented analyzer set.osexitinlibrary.Analyzerin usage/docs to match the exported linter API.Example of the newly documented API surface in specs: