docs: remove shell prompt $ from code blocks in README#3373
Open
avasis-ai wants to merge 1 commit into
Open
Conversation
The $ prefix in code blocks makes GitHub's 'Copy code' button include it when copying, causing friction when pasting commands into a terminal.
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.
Summary
Removes the
$shell prompt prefix from all code blocks in the README.The
$prefix makes GitHub's "Copy code" button include it when copying, which causes friction when pasting commands into a terminal (the shell tries to execute$as a command).This is a common convention in modern documentation — shell prompts in code blocks are considered obsolete since code blocks already visually distinguish commands from prose.
Closes #3323