Fix e.g. → e.g., in view and experiments analyze help text#36695
Merged
pelikhan merged 4 commits intoJun 3, 2026
Conversation
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix CLI flag descriptions to use e.g., consistently
Fix e.g. → e.g., in view and experiments analyze help text
Jun 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes CLI help-text punctuation by fixing remaining e.g. occurrences to e.g., in command long descriptions, and adds regression coverage to ensure future help text adheres to the same convention.
Changes:
- Update
viewcommand long help text to use(e.g., ...)punctuation. - Update
experiments analyzecommand long help text to usee.g.,punctuation. - Extend CLI consistency tests to assert the corrected punctuation for both commands.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/view_command.go | Fixes e.g. punctuation in the view command Long help text. |
| pkg/cli/experiments_command.go | Fixes e.g. punctuation in the experiments analyze subcommand Long help text. |
| pkg/cli/cli_consistency_help_test.go | Adds assertions to prevent e.g., punctuation regressions in view and experiments analyze help text. |
| .github/workflows/deep-report.lock.yml | Updates the generated workflow lock metadata body_hash (not mentioned in PR description). |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 1
| @@ -1,4 +1,4 @@ | |||
| # gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"b1378e3a94dc80144c9098262e28b1643aa88cc03737e623786dd73e87d8319f","body_hash":"d9aeb7d1ad73b83d345a7b34a53f3878ebc8fb846420f8e7cf5bb129711c0a4e","strict":true,"agent_id":"claude"} | |||
| # gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"b1378e3a94dc80144c9098262e28b1643aa88cc03737e623786dd73e87d8319f","body_hash":"998dc32188e283fc86b37ca07bef72bd4c957f0282c50af482395434a8b2cb66","strict":true,"agent_id":"claude"} | |||
pelikhan
deleted the
copilot/deep-report-quick-win-fix-cli-flag-descriptions
branch
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 2026-06-02 CLI consistency audit (H1) flagged 5+ flag descriptions using
e.g.without the trailing comma. The originally identified 5 cases were already fixed onmain; this PR addresses the 2 remaining occurrences in commandLongdescriptions that weren't caught.Changes
pkg/cli/view_command.go:(e.g. issues, pull requests,→(e.g., issues, pull requests,pkg/cli/experiments_command.go:prefix, e.g. "my-workflow"→prefix, e.g., "my-workflow"pkg/cli/cli_consistency_help_test.go: ExtendedTestHelpTextUsesStandardEgPunctuationwith assertions forviewandexperiments analyzeto prevent regression