Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 18, 2025

Documentation used plural "pull requests" while the command implementation and help text use singular "a pull request".

Change

  • docs/src/content/docs/setup/cli.md: Changed description from "Transfer pull requests between repositories." to "Transfer a pull request to another repository."

Context

The command accepts exactly one PR URL (Args: cobra.ExactArgs(1)) and the source code short description is "Transfer a pull request to another repository". Documentation now matches implementation.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Minor inconsistency in pr transfer command description</issue_title>
<issue_description>## Issue Description

Command: gh aw pr transfer
Type: Documentation inconsistency with source code
Priority: Low

Current State

In Documentation (docs/src/content/docs/setup/cli.md line 395-402):

##### `pr transfer`

Transfer pull requests between repositories.

In Source Code (pkg/cli/pr_command.go line 59):

Short: "Transfer a pull request to another repository",

Issue

The documentation uses plural "pull requests" while the command's short description uses singular "a pull request".

The command implementation confirms it only transfers ONE pull request at a time:

  • Command definition: Args: cobra.ExactArgs(1) (line 76 of pkg/cli/pr_command.go)
  • Usage: Use: "transfer PULL-REQUEST-URL" (line 58)

Suggested Fix

Update documentation to match the source code's singular form for technical accuracy:

##### `pr transfer`

Transfer a pull request to another repository.

Context

This was discovered during CLI consistency analysis. The singular form is more accurate since the command only accepts a single PR URL as an argument.


Note: This analysis was conducted through source code review. Verification against actual CLI --help output is recommended.

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.

Update documentation to match source code implementation.
The command only accepts one PR at a time (Args: cobra.ExactArgs(1)),
so "pull request" (singular) is more accurate than "pull requests" (plural).

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix inconsistency in pr transfer command documentation Fix pr transfer command documentation inconsistency Nov 18, 2025
Copilot AI requested a review from pelikhan November 18, 2025 17:00
Copilot finished work on behalf of pelikhan November 18, 2025 17:00
@pelikhan pelikhan marked this pull request as ready for review November 18, 2025 19:06
Copilot AI review requested due to automatic review settings November 18, 2025 19:06
@pelikhan pelikhan merged commit 0b17221 into main Nov 18, 2025
66 checks passed
@pelikhan pelikhan deleted the copilot/fix-pr-transfer-command-docs branch November 18, 2025 19:06
Copilot finished reviewing on behalf of pelikhan November 18, 2025 19:08
Copy link
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 documentation inconsistency where the pr transfer command description used plural "pull requests" when the command implementation only accepts a single PR URL. The documentation now correctly states "Transfer a pull request to another repository" to match the source code's singular form.

  • Updated documentation to use singular form "a pull request" instead of plural "pull requests"

💡 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] Minor inconsistency in pr transfer command description

2 participants