From 24c00a3b29fae2da07facdf9ed43850ebbfe7778 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Thu, 25 Jan 2024 21:24:26 +0100 Subject: [PATCH] unify helptexts --- ansiblelater/rules/CheckDeprecated.py | 2 +- ansiblelater/rules/CheckNameFormat.py | 2 +- ansiblelater/rules/CheckNamedTask.py | 2 +- ansiblelater/rules/CheckUniqueNamedTask.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ansiblelater/rules/CheckDeprecated.py b/ansiblelater/rules/CheckDeprecated.py index 561313b..6ab1770 100644 --- a/ansiblelater/rules/CheckDeprecated.py +++ b/ansiblelater/rules/CheckDeprecated.py @@ -4,7 +4,7 @@ from ansiblelater.rule import RuleBase class CheckDeprecated(RuleBase): sid = "ANSIBLE9999" description = "Deprecated features should not be used" - helptext = "'{old}' is deprecated and should not be used anymore. Use '{new}' instead." + helptext = "`{old}` is deprecated and should not be used anymore. Use `{new}` instead." types = ["playbook", "task", "handler"] def check(self, candidate, settings): diff --git a/ansiblelater/rules/CheckNameFormat.py b/ansiblelater/rules/CheckNameFormat.py index 85c1974..5ac930e 100644 --- a/ansiblelater/rules/CheckNameFormat.py +++ b/ansiblelater/rules/CheckNameFormat.py @@ -6,7 +6,7 @@ from ansiblelater.rule import RuleBase class CheckNameFormat(RuleBase): sid = "ANSIBLE0007" description = "Name of tasks and handlers must be formatted" - helptext = "name '{name}' should start with uppercase" + helptext = "name `{name}` should start with uppercase" types = ["playbook", "task", "handler"] def check(self, candidate, settings): diff --git a/ansiblelater/rules/CheckNamedTask.py b/ansiblelater/rules/CheckNamedTask.py index 9ee85f8..dff26a3 100644 --- a/ansiblelater/rules/CheckNamedTask.py +++ b/ansiblelater/rules/CheckNamedTask.py @@ -4,7 +4,7 @@ from ansiblelater.rule import RuleBase class CheckNamedTask(RuleBase): sid = "ANSIBLE0006" description = "Tasks and handlers must be named" - helptext = "module '{module}' used without or empty `name` attribute" + helptext = "module `{module}` used without or empty `name` attribute" types = ["playbook", "task", "handler"] def check(self, candidate, settings): diff --git a/ansiblelater/rules/CheckUniqueNamedTask.py b/ansiblelater/rules/CheckUniqueNamedTask.py index 5e7ff00..68f4dec 100644 --- a/ansiblelater/rules/CheckUniqueNamedTask.py +++ b/ansiblelater/rules/CheckUniqueNamedTask.py @@ -6,7 +6,7 @@ from ansiblelater.rule import RuleBase class CheckUniqueNamedTask(RuleBase): sid = "ANSIBLE0003" description = "Tasks and handlers must be uniquely named within a single file" - helptext = "name '{name}' appears multiple times" + helptext = "name `{name}` appears multiple times" types = ["playbook", "task", "handler"] def check(self, candidate, settings):