Clarify flag description

aaronlehmann · mafredri · web-flow · commit 790537cd68a2 · 2025-01-10T06:15:20.000-08:00
Co-authored-by: Mathias Fredriksson &lt;mafredri@gmail.com&gt;
diff --git a/cli/ssh.go b/cli/ssh.go
@@ -485,7 +485,7 @@ func (r *RootCmd) ssh() *serpent.Command {
 		{
 			Flag:        "ssh-host-prefix",
 			Env:         "CODER_SSH_SSH_HOST_PREFIX",
-			Description: "Strip this prefix from the provided hostname to determine the workspace name.",
+			Description: "Strip this prefix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command.",
 			Value:       serpent.StringOf(&hostPrefix),
 		},
 		{

Original file line number	Diff line number	Diff line change
`@@ -485,7 +485,7 @@ func (r RootCmd) ssh() serpent.Command {`
`485`	`485`	`{`
`486`	`486`	`Flag: "ssh-host-prefix",`
`487`	`487`	`Env: "CODER_SSH_SSH_HOST_PREFIX",`
`488`		`- Description: "Strip this prefix from the provided hostname to determine the workspace name.",`
	`488`	`+ Description: "Strip this prefix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command.",`
`489`	`489`	`Value: serpent.StringOf(&hostPrefix),`
`490`	`490`	`},`
`491`	`491`	`{`