Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix --spawn tag not in code tag #2972

Closed
wants to merge 1 commit into from
Closed

Conversation

JuanitoFatas
Copy link
Member

Simple fix for the missing code tag wrapped for --spawn in below screenshot

CleanShot 2024-09-12 at 08 08 56@2x

@buildkite-docs-bot
Copy link
Contributor

Preview URL: https://2972--bk-docs-preview.netlify.app

@gilesgas
Copy link
Contributor

Thanks @JuanitoFatas , but I doubt this fix will last long, as this page's content is automatically re-generated from the relevant agent source code, which converts the forward ticks (in the agent source code) to backticks in the resulting Markdown/HTML of the docs.

We can't really change this to HTML tags in the agent source because these descriptions are used in the command line help options (i.e. buildkite-agent start --help), where these tags are likely to be rendered literally as is.

It might be worthwhile investigating if the relevant script that does this conversion for the docs can change the pairs of forward ticks to <code></code> tags in the resulting Markdown (for the HTML).

@JuanitoFatas
Copy link
Member Author

@gilesgas You’re right I fixed in the wrong place 🤦🏻‍♂️

auto-merge was automatically disabled September 11, 2024 23:34

Pull request was closed

@JuanitoFatas JuanitoFatas deleted the fix-code-styling branch September 11, 2024 23:34
@gilesgas
Copy link
Contributor

No worries @JuanitoFatas , this can't be fixed until the relevant cli2md.rb script has been updated to handle forward ticks, which I also just discovered are called 'prime' symbols. Thanks again for caring!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants