Skip to content

[cli-consistency] Standardize e.g., punctuation across CLI help text#36513

Merged
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fixes
Jun 2, 2026
Merged

[cli-consistency] Standardize e.g., punctuation across CLI help text#36513
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fixes

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 2, 2026

CLI consistency checks found remaining help text outliers using e.g. instead of the project-standard e.g., in several command/flag descriptions. This PR aligns those strings across CLI and mirrored docs/MCP help surfaces.

  • CLI help text normalization

    • Updated the affected help strings to use e.g., in:
      • deploy / update --cool-down usage text
      • env parent command long description
      • compile --schedule-seed flag usage
      • domains long description
      • checks long description
  • Mirrored surface consistency

    • Updated the corresponding checks MCP tool description to keep wording consistent with CLI output.
    • Updated the CLI setup docs sentence for domains to match the same punctuation convention.
  • Regression coverage

    • Added focused assertions in help-text consistency tests to enforce e.g., punctuation for the touched command surfaces.
const coolDownFlagUsage = "Cooldown period before applying a new release (e.g., 7d, 24h, 0 to disable). Does not apply to actions/* or github/* repositories"

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 e.g., punctuation across CLI help text Jun 2, 2026
Copilot AI requested a review from gh-aw-bot June 2, 2026 19:44
@pelikhan pelikhan marked this pull request as ready for review June 2, 2026 19:50
Copilot AI review requested due to automatic review settings June 2, 2026 19:50
@pelikhan pelikhan merged commit dabcc68 into main Jun 2, 2026
@pelikhan pelikhan deleted the copilot/cli-consistency-fixes branch June 2, 2026 19:50
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-seed usage).
  • 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"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] CLI Consistency Issues - 2026-06-02

4 participants