Added backticks around ascii warnings to format correctly in docs#852
Merged
Added backticks around ascii warnings to format correctly in docs#852
Conversation
yuandrew
approved these changes
Sep 4, 2025
Contributor
yuandrew
left a comment
There was a problem hiding this comment.
LGTM! you'll need to run go run ./temporalcli/internal/cmd/gen-commands to re-generate the commands.gen.go file
stephanos
pushed a commit
to sivagirish81/cli
that referenced
this pull request
Oct 2, 2025
…mporalio#852) <!--- Note to EXTERNAL Contributors --> <!-- Thanks for opening a PR! If it is a significant code change, please **make sure there is an open issue** for this. We work best with you when we have accepted the idea first before you code. --> <!--- For ALL Contributors 👇 --> ## What was changed The ASCII warning blocks were rendering incorrectly on the docs site. The fix is to add backticks around these blocks. It looks like the format will still be ok in the CLI `--help` messages, they will just be bolded like some of the commands in the `--help` results. Without fix: <img width="1986" height="868" alt="image" src="https://github.com/user-attachments/assets/96a4a030-0686-434a-80fa-da378131883a" /> With fix: <img width="946" height="325" alt="Screenshot 2025-09-04 at 10 40 05" src="https://github.com/user-attachments/assets/97ffda9d-63bf-4ed0-86f3-bea1cdea3283" /> ## Why? <!-- Tell your future self why have you made these changes --> ## Checklist <!--- add/delete as needed ---> 1. Closes <!-- add issue number here --> 2. How was this tested: <!--- Please describe how you tested your changes/how we can test them --> 3. Any docs updates needed? <!--- update README if applicable or point out where to update docs.temporal.io -->
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
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
The ASCII warning blocks were rendering incorrectly on the docs site. The fix is to add backticks around these blocks. It looks like the format will still be ok in the CLI
--helpmessages, they will just be bolded like some of the commands in the--helpresults.Without fix:

With fix:

Why?
Checklist
Closes
How was this tested: