From 60c8059c53103380237b3ad8b92a4f3ab6538169 Mon Sep 17 00:00:00 2001 From: BethanyG Date: Wed, 11 Feb 2026 12:50:49 -0800 Subject: [PATCH] Removed the Ruby %Q string interpolation from the templates, as it was not working. --- analyzer-comments/python/pylint/convention.md | 6 +++--- analyzer-comments/python/pylint/error.md | 7 +++---- analyzer-comments/python/pylint/informatonal.md | 6 +++--- analyzer-comments/python/pylint/refactor.md | 6 +++--- analyzer-comments/python/pylint/warning.md | 7 +++---- 5 files changed, 15 insertions(+), 17 deletions(-) diff --git a/analyzer-comments/python/pylint/convention.md b/analyzer-comments/python/pylint/convention.md index 21f4b3410..98dd348b8 100644 --- a/analyzer-comments/python/pylint/convention.md +++ b/analyzer-comments/python/pylint/convention.md @@ -7,9 +7,9 @@ This code doesn't follow general [Python code style][code style] conventions. While this type of issue generally doesn't affect the way code _executes_, it can hurt readability or the performance of automated tools such as documentation generators or test runners. -%Q{Instead of:\n\n```python\n#{bad_code}\n```\n} -%Q{Try:\n\n```python\n#{good_code}\n```\n\n} -%Q{Additional information:\n #{related_info}\n} +%{bad_code} +%{good_code} +%{related_info} %{details} [code style]: https://www.python.org/dev/peps/pep-0008/ diff --git a/analyzer-comments/python/pylint/error.md b/analyzer-comments/python/pylint/error.md index be095c53b..735e072f4 100644 --- a/analyzer-comments/python/pylint/error.md +++ b/analyzer-comments/python/pylint/error.md @@ -6,8 +6,7 @@ This code has an error or problem that should be addressed. -%Q{Instead of:\n\n```python\n#{bad_code}\n```\n} -%Q{Try:\n\n```python\n#{good_code}\n```\n\n} -%Q{Additional information:\n #{related_info}\n} +%{bad_code} +%{good_code} +%{related_info} %{details} - diff --git a/analyzer-comments/python/pylint/informatonal.md b/analyzer-comments/python/pylint/informatonal.md index 44913d567..7ba05c2e5 100644 --- a/analyzer-comments/python/pylint/informatonal.md +++ b/analyzer-comments/python/pylint/informatonal.md @@ -7,7 +7,7 @@ There is `FIXME`/`TODO`/`XXX` style comment or other "informational" pattern or note in the code. These tags are often used to annotate places where code is stubbed out but needs work - or to highlight potential design flaws or bugs that need to be addressed in the future. -%Q{Instead of:\n\n```python\n#{bad_code}\n```\n} -%Q{Try:\n\n```python\n#{good_code}\n```\n\n} -%Q{Additional information:\n #{related_info}\n} +%{bad_code} +%{good_code} +%{related_info} %{details} diff --git a/analyzer-comments/python/pylint/refactor.md b/analyzer-comments/python/pylint/refactor.md index 75aecbe80..8bd403ae7 100644 --- a/analyzer-comments/python/pylint/refactor.md +++ b/analyzer-comments/python/pylint/refactor.md @@ -10,9 +10,9 @@ a re-write or refactor. appears to have one or more patterns that could lead to _future_ bugs or maintenance issues. Consider taking a closer look at it. -%Q{Instead of:\n\n```python\n#{bad_code}\n```\n} -%Q{Try:\n\n```python\n#{good_code}\n```\n\n} -%Q{Additional information:\n #{related_info}\n} +%{bad_code} +%{good_code} +%{related_info} %{details} [code smell]: https://en.wikipedia.org/wiki/Code_smell diff --git a/analyzer-comments/python/pylint/warning.md b/analyzer-comments/python/pylint/warning.md index 040660916..14cdf7450 100644 --- a/analyzer-comments/python/pylint/warning.md +++ b/analyzer-comments/python/pylint/warning.md @@ -8,8 +8,7 @@ There is an issue in the code that could lead to a bug or error in the program. While this error might not be _severe_, it could lead to more severe issues in the future. It is recommended the problem be addressed before proceeding further. -%Q{Instead of:\n\n```python\n#{bad_code}\n```\n} -%Q{Try:\n\n```python\n#{good_code}\n```\n\n} -%Q{Additional information:\n #{related_info}\n} +%{bad_code} +%{good_code} +%{related_info} %{details} -