Document backtick-quoting code in prose

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-14 01:01:28 +01:00
parent fce36e22b9
commit f4d89c06c9
1 changed files with 4 additions and 0 deletions
@@ -49,6 +49,10 @@ Python uses **single-quoted strings** (`'...'`). Reformat with
 `ruff format --config "format.quote-style='single'" <paths>` (ruff is available via
 `nix run nixpkgs#ruff`). Docstrings stay triple-double-quoted (`"""`).

+In prose (commit messages, docs, comments), backtick-quote anything code-like —
+paths, filenames, identifiers, commands, endpoints — rather than plain or
+double-quoted text.
+
 ## Working with the capture

 Read flows with the mitmproxy Python API: