Emit bash language token for CLI usage fences#4759
Closed
allister-beamable wants to merge 1 commit into
Closed
Conversation
DocService.GetUsage wraps the command usage template in a ```shell fence. Pygments (used by the docs site's pymdownx.highlight) treats shell, sh, and bash as the same Bash lexer, but the docs standardize on bash as the single token for typed shell commands. Emitting bash keeps the generated CLI command reference consistent with the hand-written guides. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Closing — the docs will standardize on |
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
DocService.GetUsage(cli/cli/Services/Docs/DocService.cs) wraps each command's usage template in a```shellfence. This changes it to```bash.Why
The docs site standardizes on
bashas the single language token for typed shell commands (the hand-written CLI guides were just normalizedshell/sh→bashin beamable/docs). The generated CLI command reference is regenerated from this code, so its ~200-per-branch usage fences can only be standardized here — editing the generated Markdown in the docs repo would be overwritten on the next regen.shell,sh, andbashall resolve to the same Pygments Bash lexer, so rendering is unchanged; this is a source-consistency fix that lets the whole docs site use one token per language.Scope
One-line string change; the usage block is a typed command template (
beam <command> [options]), sobashis the correct token. No behavior change beyond the emitted token.🤖 Generated with Claude Code