Consistent console formatting for "Git bootcamp and cheat sheet" #1231
Conversation
This file contains 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
hugovk
changed the title
hugovk
changed the title
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.
A lot of the console commands at https://devguide.python.org/getting-started/git-boot-camp/ are shown in italics.
This is because the default highlight is set to console:
That means the commands should be prefixed with a $ prompt. Normally this is so you can show some a command, and have its output in different formatting.
Generally, we should use a
bashhighlighting if there's no output, and omit the $ prompt. However, we've set the copybutton Sphinx extension to$which means you can still copy/paste the example and the $ prompt doesn't come along.I don't really mind which we use -- console and prompts, or bash and no prompt -- but we should use the right combination.
📚 Documentation preview 📚: https://cpython-devguide--1231.org.readthedocs.build/getting-started/git-boot-camp/