From 8dea47afc1c5e18faaad1bdfe2b53f9a065f9ada Mon Sep 17 00:00:00 2001 From: Calum Young <32770960+calumy@users.noreply.github.com> Date: Tue, 9 May 2023 17:36:13 +0100 Subject: [PATCH] Update `mkdocs` unformatted example error message (#4312) --- scripts/check_docs_formatted.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/check_docs_formatted.py b/scripts/check_docs_formatted.py index 9934af74b8..49c7741aa4 100755 --- a/scripts/check_docs_formatted.py +++ b/scripts/check_docs_formatted.py @@ -103,8 +103,8 @@ def format_file( if contents != new_contents: rule_name = file.name.split(".")[0] print( - f"Rule `{rule_name}` docs are not formatted. This section should be " - f"rewritten to:", + f"Rule `{rule_name}` docs are not formatted. The example section " + f"should be rewritten to:", ) # Add indentation so that snipped can be copied directly to docs