Consistently use single quotes in actionable commands in user-facing messages. #2887
Conversation
…messages. Shells can interpret backticks in special circumstances, so use quotes to be safe.
| @@ -65,7 +65,7 @@ func (r *Repo) CloneProject(owner, name, path string, out output.Outputer, an an | |||
| err = locale.WrapError(err, "err_clone_repo", "Could not clone repository with URL: {{.V0}}, error received: {{.V1}}.", *project.RepoURL, err.Error()) | |||
| tipMsg := locale.Tl( | |||
| "err_tip_git_ssh-add", | |||
| "If you are using an SSH key please ensure it's configured by running `[ACTIONABLE]ssh-add <path-to-key>[/RESET]`.", | |||
| "If you are using an SSH key please ensure it's configured by running '[ACTIONABLE]ssh-add <path-to-key>[/RESET]'.", | |||
There was a problem hiding this comment.
This localization has the quotes before the tag whereas some others have it after the tag and around the command. Normally, I wouldn't be this nitpicky but since this PR is about consistency we should make sure they follow the same pattern. Additionally, is there any difference to the output where the quotes are placed? I assume not, but we should verify just to be sure.
There was a problem hiding this comment.
You are right. I got confused reading my own ticket, thinking that single quotes either inside or outside the tags are okay (i.e. leave them be position-wise, just make sure they're single quotes).
However I agree that we should be consistent. The quotes should be outside the tags so that only the actionable text is highlighted. It makes it more clear what the user should type (no confusion on whether or not to type/include quotes, haha).
It better distinguishes what users should type.
Shells can interpret backticks in special circumstances, so use quotes to be safe.