docs: correct --delete-remote wording (origin branch, not tracking ref)#25
Merged
Conversation
…cking ref) wt delete --delete-remote runs `git push origin --delete <branch>`, which deletes the branch on origin — not the local remote-tracking ref. Both docs/specs/cli-surface.md and docs/site/workflows.md described it as deleting the "remote-tracking branch," which is inaccurate. Align both with the delete.go --delete-remote help text corrected in #24. Docs-only follow-up to #24; no code or behavior change.
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
2 participants
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.
What
Both
docs/specs/cli-surface.mdanddocs/site/workflows.mddescribedwt delete --delete-remoteas deleting the remote-tracking branch. That's inaccurate:DeleteRemoteBranchrunsgit push origin --delete <branch>(src/internal/worktree/git.go:99-100), which deletes the branch on origin — not the local remote-tracking ref.This aligns both docs with the
--delete-remotehelp text indelete.gothat was corrected in #24:Why
Follow-up to #24. Copilot's review there corrected the in-code help string but flagged that the same wrong phrasing remained in the spec and the site doc (out of scope for that PR). This closes that gap so the spec (source of truth) and site doc match the implementation.
Scope
Docs-only — two lines, no code or behavior change. No tests affected.