code review

spikecurtis · spikecurtis · commit c45e4db5018e · 2025-04-07T17:05:16.000Z
diff --git a/cli/ssh.go b/cli/ssh.go
@@ -572,7 +572,7 @@ func (r *RootCmd) ssh() *serpent.Command {
 		{
 			Flag:        "hostname-suffix",
 			Env:         "CODER_SSH_HOSTNAME_SUFFIX",
-			Description: "Strip this suffix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. The suffix should be specified WITHOUT a leading . character.",
+			Description: "Strip this suffix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. The suffix must be specified without a leading . character.",
 			Value:       serpent.StringOf(&hostnameSuffix),
 		},
 		{
diff --git a/cli/testdata/coder_ssh_--help.golden b/cli/testdata/coder_ssh_--help.golden
@@ -26,7 +26,7 @@ OPTIONS:
       --hostname-suffix string, $CODER_SSH_HOSTNAME_SUFFIX
           Strip this suffix from the provided hostname to determine the
           workspace name. This is useful when used as part of an OpenSSH proxy
-          command. The suffix should be specified WITHOUT a leading . character.
+          command. The suffix must be specified without a leading . character.
 
       --identity-agent string, $CODER_SSH_IDENTITY_AGENT
           Specifies which identity agent to use (overrides $SSH_AUTH_SOCK),
diff --git a/docs/reference/cli/ssh.md b/docs/reference/cli/ssh.md

Original file line number	Diff line number	Diff line change
`@@ -572,7 +572,7 @@ func (r RootCmd) ssh() serpent.Command {`
`572`	`572`	`{`
`573`	`573`	`Flag: "hostname-suffix",`
`574`	`574`	`Env: "CODER_SSH_HOSTNAME_SUFFIX",`
`575`		`- Description: "Strip this suffix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. The suffix should be specified WITHOUT a leading . character.",`
	`575`	`+ Description: "Strip this suffix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. The suffix must be specified without a leading . character.",`
`576`	`576`	`Value: serpent.StringOf(&hostnameSuffix),`
`577`	`577`	`},`
`578`	`578`	`{`