docs(style[shell]): Standardize shell code blocks#535
Merged
Conversation
why: Standardize shell code blocks for copy-pastability and readability what: - Add console language tag + $ prefix rule - Add line continuation rule for wide multi-flag commands - Scope to documentation shell examples, not doctests
why: Improve copy-pastability and readability of shell examples what: - Ensure all shell blocks use console tag with $ prefix - Fix docs/cli/completion.md shtab examples - Fix CHANGES shell examples - Convert non-command bash block to plain code block
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #535 +/- ##
=======================================
Coverage 84.24% 84.24%
=======================================
Files 29 29
Lines 3795 3795
Branches 756 756
=======================================
Hits 3197 3197
Misses 378 378
Partials 220 220 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
why: Apply the line-splitting rule from Shell Command Formatting guidelines what: - Split pipx install command in CHANGES header - Split long jq pipe commands in README.md and docs/cli/status.md
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
Changes
bash/zsh→consoletags, add$prefix (preserves .bashrc/.zshrc content blocks)sh/bash→consoletags, add$prefix, fix migration table block