Skip to content

Commit 2b82402

Browse files
skarimCopilot
andauthored
apply suggested docs updates from code review
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 2fb3a99 commit 2b82402

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/src/content/docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ gh stack link change1 change2 change3
245245

246246
This doesn't create any local tracking and only hits the APIs to create Stacked PRs.
247247

248-
If the provided branches already have open PRs, `link` will use them. If not, it creates draft PRs with the correct base branch chaining.
248+
If the provided branches already have open PRs, `link` will use them. If not, it creates draft PRs by default with the correct base branch chaining.
249249

250250
To add more to the stack, run `link` again, but be sure to include the full list of PRs/branches in the stack:
251251

docs/src/content/docs/reference/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,12 +233,12 @@ gh stack submit [flags]
233233

234234
Creates a Stacked PR for every branch in the stack, pushing branches to the remote. After creating PRs, `submit` automatically creates a **Stack** on GitHub to link the PRs together. If the stack already exists on GitHub (e.g., from a previous submit), new PRs are added to the existing stack.
235235

236-
When creating new PRs, you will be prompted to enter a title for each one. Press Enter to accept the default (branch name), or use `--auto` to skip prompting entirely.
236+
When creating new PRs, you will be prompted to enter a title for each one. Press Enter to accept the default (branch name), or use `--auto` to skip prompting entirely. New PRs are created as **drafts by default**; use `--open` to create new PRs as ready for review and to mark existing PRs as ready for review.
237237

238238
| Flag | Description |
239239
|------|-------------|
240240
| `--auto` | Use auto-generated PR titles without prompting |
241-
| `--open` | Mark new and existing PRs as ready for review |
241+
| `--open` | Create new PRs as ready for review instead of drafts, and mark existing PRs as ready for review |
242242
| `--remote <name>` | Remote to push to (defaults to auto-detected remote) |
243243

244244
**Examples:**

0 commit comments

Comments
 (0)