fix: improve consistency of backticks in usage messages#863
Merged
dandavison merged 1 commit intotemporalio:mainfrom Nov 13, 2025
Merged
fix: improve consistency of backticks in usage messages#863dandavison merged 1 commit intotemporalio:mainfrom
dandavison merged 1 commit intotemporalio:mainfrom
Conversation
|
|
dandavison
reviewed
Nov 12, 2025
| s.Command.Short = "Show Workflow Executions" | ||
| if hasHighlighting { | ||
| s.Command.Long = "List Workflow Executions. The optional \x1b[1m--query\x1b[0m limits the output to\nWorkflows matching a Query:\n\n\x1b[1mtemporal workflow list \\\n --query YourQuery\x1b[1m\x1b[0m\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation. See \x1b[0mtemporal batch --help` for a quick reference.\n\nView a list of archived Workflow Executions:\n\n\x1b[1mtemporal workflow list \\\n --archived\x1b[0m" | ||
| s.Command.Long = "List Workflow Executions. The optional \x1b[1m--query\x1b[0m limits the output to\nWorkflows matching a Query:\n\n\x1b[1mtemporal workflow list \\\n --query YourQuery\x1b[0m\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation. See \x1b[1mtemporal batch --help\x1b[0m for a quick reference.\n\nView a list of archived Workflow Executions:\n\n\x1b[1mtemporal workflow list \\\n --archived\x1b[0m" |
Contributor
There was a problem hiding this comment.
Anyone know why the ANSI escapes changed here? Haven't tested in a terminal but the new version LGTM. (1m is a transition to bold and 0m is a transition that removes all flags.)
Member
Author
There was a problem hiding this comment.
I believe this is related to this change; previously there was an extraneous hanging backtick on the code block for temporal workflow list --query YourQuery, so the parser that creates the highlighted version of the help text may have gotten a bit confused. Here's how it looks today:
With this patch:
This is actually the exact typo that I noticed that sent me down this rabbit hole 😄
Contributor
There was a problem hiding this comment.
Excellent, thanks for looking into this.
dandavison
approved these changes
Nov 12, 2025
Contributor
dandavison
left a comment
dandavison
left a comment
There was a problem hiding this comment.
Thanks @stpierre! LGTM
* Remove extraneous trailing backticks * Add missing backticks where obviously needed * Improve consistency of quoting This doesn't fix every inconsistent use of backticks, but it does remove a few dangling backticks, and in places where quoting was inconsistent (i.e., a mix of backticks, quotes, and/or no quotes in a single usage message) makes it slightly more consistent.
stpierre
force-pushed
the
audit-backticks
branch
from
3f52554 to
8aca3ec
Compare
spkane31
approved these changes
Nov 13, 2025
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
4 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 was changed
This doesn't fix every inconsistent use of backticks, but it does remove a few dangling backticks, and in places where quoting was inconsistent (i.e., a mix of backticks, quotes, and/or no quotes in a single usage message) makes it slightly more consistent.
Why?
Prettier usage :)
Checklist
Closes
How was this tested: