Remove shell prompt prefixes from README code blocks - #3437
Open
driphtyio wants to merge 1 commit into
Open
Conversation
The $ prefix before commands in code blocks is a holdover from the pre-code-block era. Modern GitHub renders code blocks with a copy button that copies the full block content including the $, which breaks paste-to-terminal workflows. This change removes the $ prefix from all shell commands in the Installation, Building, and Running tests sections while preserving actual shell variable references like $(arch). Fixes BurntSushi#3323
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
1 participant
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 prefix from shell commands in README code blocks. Modern GitHub code blocks have a copy button that copies the full content including the , which breaks paste-to-terminal workflows.
Changes
Context
Fixes #3323. The maintainer mentioned being open to reconsidering this (see comment).
Before
After