-
Notifications
You must be signed in to change notification settings - Fork 199
Remove back-ticks from output strings #601
Comments
Hello @mkevinosullivan, it looks like @paulomarg already removed the extraneous back-ticks with commit 4e3d52f but forgot to close this issue. This comment also acts as a public service announcement for people coming from the website Good First Commit of the Week. |
Hey @cixtor! I think the idea behind this issue is to go over the messages in general and look for instances of this issue. I most likely did not catch all of them when I made my change, since I was changing quite a few things. |
I already scanned the entire project at commit 41b4963 and found 1,249 instances of the extraneous back-ticks. However, 210 are in comments, 252 are in Markdown files, 770 are in
|
Great job collecting all of these! All of the backticks on the |
Issue summary
Remove back-ticks from output strings, especially if the end-user is expected to reproduce on the command line, as instructed by a help output. This should be attempted once PR #587 is completed (output strings will be centralized in
messages.rb
files).Actual behavior
On Unix-based systems, back-ticks cause the content to be executed, so (as an example) the following output string from
shopify help load-dev
is mis-leading, as it can be easily interpreted for the developer to include the back-ticks in the command, which is not intended.In this case, it would be advisable to remove the back-ticks altogether; in other cases (usually to highlight a piece of text), it would be better to find an alternative to do so (e.g., bold, different colour, etc.).
The text was updated successfully, but these errors were encountered: