From 2045b739a9b0e8e6c8a4e490886216e5889b0e2a Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Thu, 5 Jan 2023 15:46:49 +0100 Subject: [PATCH] Stop highlighting --help output in README as shell (#1655) This PR is meant to address the following obviously unintended GitHub rendering: ![image](https://user-images.githubusercontent.com/73739153/210713719-7fb465b1-db91-4074-8a0c-4efa3c47c2f4.png) --- README.md | 2 +- ruff_dev/src/generate_cli_help.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d08d2e64f4..94f59937c2 100644 --- a/README.md +++ b/README.md @@ -312,7 +312,7 @@ ruff path/to/code/ --select F401 --select F403 See `ruff --help` for more: -```shell +``` Ruff: An extremely fast Python linter. Usage: ruff [OPTIONS] [FILES]... diff --git a/ruff_dev/src/generate_cli_help.rs b/ruff_dev/src/generate_cli_help.rs index 6ae1385b88..68039ca6ed 100644 --- a/ruff_dev/src/generate_cli_help.rs +++ b/ruff_dev/src/generate_cli_help.rs @@ -28,7 +28,7 @@ pub fn main(cli: &Cli) -> Result<()> { print!("{output}"); } else { replace_readme_section( - &format!("```shell\n{output}\n```\n"), + &format!("```\n{output}\n```\n"), HELP_BEGIN_PRAGMA, HELP_END_PRAGMA, )?;