[cli-consistency] Standardize e.g., punctuation across CLI help text#36513
Merged
Conversation
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix CLI consistency issues with examples
[cli-consistency] Standardize Jun 2, 2026
e.g., punctuation across CLI help text
Contributor
There was a problem hiding this comment.
Pull request overview
Standardizes e.g., punctuation across user-facing CLI help text (and mirrored MCP/docs surfaces) to match the project’s help-text convention, and adds regression tests to prevent future drift.
Changes:
- Normalized multiple CLI help strings to use
e.g.,(cool-down usage, env/domains/checks long help, compile--schedule-seedusage). - Updated mirrored surfaces (MCP tool description + setup docs) to match CLI wording.
- Added targeted help-text consistency assertions covering the touched command surfaces.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/update_cooldown.go | Updates --cool-down usage text to e.g., punctuation. |
| pkg/cli/mcp_tools_readonly.go | Aligns MCP checks tool description punctuation with CLI help text. |
| pkg/cli/env_command.go | Normalizes env long help example punctuation to e.g.,. |
| pkg/cli/domains_command.go | Normalizes domains long help example punctuation to e.g.,. |
| pkg/cli/cli_consistency_help_test.go | Adds focused assertions to enforce e.g., on the touched CLI help surfaces. |
| pkg/cli/checks_command.go | Normalizes checks long help example punctuation to e.g.,. |
| docs/src/content/docs/setup/cli.md | Updates domains docs sentence to match CLI e.g., punctuation. |
| cmd/gh-aw/main.go | Normalizes compile --schedule-seed usage example punctuation to e.g.,. |
| cmd/gh-aw/main_help_text_test.go | Adds an assertion enforcing e.g., punctuation in --schedule-seed help text. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 9/9 changed files
- Comments generated: 1
| var cooldownLog = logger.New("cli:update_cooldown") | ||
|
|
||
| const coolDownFlagUsage = "Cooldown period before applying a new release (e.g. 7d, 24h, 0 to disable). Does not apply to actions/* or github/* repositories" | ||
| const coolDownFlagUsage = "Cooldown period before applying a new release (e.g., 7d, 24h, 0 to disable). Does not apply to actions/* or github/* repositories" |
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.
CLI consistency checks found remaining help text outliers using
e.g.instead of the project-standarde.g.,in several command/flag descriptions. This PR aligns those strings across CLI and mirrored docs/MCP help surfaces.CLI help text normalization
e.g.,in:deploy/update--cool-downusage textenvparent command long descriptioncompile--schedule-seedflag usagedomainslong descriptioncheckslong descriptionMirrored surface consistency
checksMCP tool description to keep wording consistent with CLI output.domainsto match the same punctuation convention.Regression coverage
e.g.,punctuation for the touched command surfaces.