Skip to content

Fix capitalization: "markdown" → "Markdown" in compile command#3697

Merged
pelikhan merged 2 commits intomainfrom
copilot/fix-capitalization-in-compile-command
Nov 12, 2025
Merged

Fix capitalization: "markdown" → "Markdown" in compile command#3697
pelikhan merged 2 commits intomainfrom
copilot/fix-capitalization-in-compile-command

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 12, 2025

The compile command used lowercase "markdown" in its short description, inconsistent with how "YAML" was capitalized in the same string.

Changes

  • Updated cmd/gh-aw/main.go line 122: Capitalized "Markdown" to match proper noun convention
- Short: "Compile markdown to YAML workflows",
+ Short: "Compile Markdown to YAML workflows",

Both markup language names now follow consistent capitalization in the CLI help text.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Capitalization inconsistency: "markdown" should be "Markdown" in compile command</issue_title>
<issue_description>## Issue Description

Command: gh aw compile
Type: Capitalization inconsistency
Priority: Low (style consistency)

Problem

The compile command uses lowercase "markdown" in its short description, but "Markdown" is a proper noun and should typically be capitalized.

Current Help Text (cmd/gh-aw/main.go:122):

Short: "Compile markdown to YAML workflows",

Suggested Fix

Capitalize "Markdown" as it's a proper noun (the Markdown markup language):

- Short: "Compile markdown to YAML workflows",
+ Short: "Compile Markdown to YAML workflows",

Note

YAML is already correctly capitalized in the same string. For consistency, both markup language names should follow the same capitalization convention.

File to Modify

  • cmd/gh-aw/main.go (line 122)

Additional Context

The long description uses "markdown workflow files" and "markdown files" (lowercase). Consider reviewing if these should also be "Markdown workflow files" for full consistency, though lowercase might be acceptable when used as an adjective.

AI generated by CLI Consistency Checker</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…description

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix capitalization inconsistency in compile command help text Fix capitalization: "markdown" → "Markdown" in compile command Nov 12, 2025
Copilot AI requested a review from pelikhan November 12, 2025 06:37
@pelikhan pelikhan marked this pull request as ready for review November 12, 2025 06:37
Copilot AI review requested due to automatic review settings November 12, 2025 06:37
@pelikhan pelikhan merged commit 561b387 into main Nov 12, 2025
97 checks passed
@pelikhan pelikhan deleted the copilot/fix-capitalization-in-compile-command branch November 12, 2025 06:39
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

This PR fixes a capitalization inconsistency in the compile command's short description, changing "markdown" to "Markdown" to match the proper noun convention used for "YAML" in the same string.

  • Updated the Short description field to capitalize "Markdown" consistently with "YAML"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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] Capitalization inconsistency: "markdown" should be "Markdown" in compile command

3 participants