docs(style[shell]): Standardize shell code blocks#644
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 - Split multi-command blocks into one command per block - Split wide multi-flag commands with \ line continuations - Fix README.md, docs/quickstart.md, docs/developing.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #644 +/- ##
==========================================
+ Coverage 51.19% 51.27% +0.07%
==========================================
Files 25 25
Lines 2590 2590
Branches 402 402
==========================================
+ Hits 1326 1328 +2
+ Misses 1094 1093 -1
+ Partials 170 169 -1 ☔ 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
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
AGENTS.md: New "Shell Command Formatting" subsection under Documentation Standards
consolelanguage tag with$prefix rule\line continuation rule for wide multi-flag commandsREADME.md:
bashblocks toconsolewith$prefixdocs/quickstart.md:
// Usage:comment outside code block as prose\continuationsdocs/developing.md:
cd docs/ && make htmlinto single command$prefix to release commandsTest plan
uv run ruff check .passes (no Python changes)just build-docsto confirm no rendering regressions