fix: render the [sandbox] tag on speak/dub help instead of eating it#150
Merged
Conversation
The speak and dub docstrings begin with a '[sandbox]' marker (adopted in #146 to flag the two TTS commands that only work against --sandbox). With rich_markup_mode="rich", Rich parsed '[sandbox]' as a style tag and dropped it, leaving a stray leading space and an invisible marker — so these two commands rendered with different indentation from every other command in both the root --help table and their own help body. Escape the bracket (raw docstring + \[sandbox]), matching the same bracket-escaping convention help_text.examples_epilog already uses, so the marker renders literally and the help lines line up with the rest.
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
2 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.
The speak and dub docstrings begin with a '[sandbox]' marker (adopted in
#146 to flag the two TTS commands that only work against --sandbox). With
rich_markup_mode="rich", Rich parsed '[sandbox]' as a style tag and dropped
it, leaving a stray leading space and an invisible marker — so these two
commands rendered with different indentation from every other command in
both the root --help table and their own help body.
Escape the bracket (raw docstring + [sandbox]), matching the same
bracket-escaping convention help_text.examples_epilog already uses, so the
marker renders literally and the help lines line up with the rest.