Minor documentation improvements (#1995)

src/ansiblelint/rules/deprecated_module.py

@@ -16,10 +16,9 @@ class DeprecatedModuleRule(AnsibleLintRule):
     id = "deprecated-module"
     description = (
         "These are deprecated modules, some modules are kept "
-        "temporarily for backwards compatibility but usage is discouraged. "
-        "For more details see: "
-        "https://docs.ansible.com/ansible/latest/collections/index_module.html"
+        "temporarily for backwards compatibility but usage is discouraged."
     )
+    link = "https://docs.ansible.com/ansible/latest/collections/index_module.html"
     severity = "HIGH"
     tags = ["deprecations"]
     version_added = "v4.0.0"

src/ansiblelint/rules/meta_incorrect.py

@@ -24,8 +24,8 @@ class MetaChangeFromDefaultRule(AnsibleLintRule):
         ("license", "license (GPLv2, CC-BY, etc)"),
         ("license", "license (GPL-2.0-or-later, MIT, etc)"),
     ]
-    description = "meta/main.yml default values should be changed for: ``{}``".format(
-        ", ".join(f[0] for f in field_defaults)
+    description = "meta/main.yml default values should be changed for: {}".format(
+        ", ".join(sorted(set((f[0] for f in field_defaults))))
     )
     severity = "HIGH"
     tags = ["metadata"]

src/ansiblelint/rules/meta_no_info.py

@@ -60,7 +60,7 @@ class MetaMainHasInfoRule(AnsibleLintRule):
     id = "meta-no-info"
     str_info = META_STR_INFO
     info = META_INFO
-    description = "meta/main.yml should contain: ``{}``".format(", ".join(info))
+    description = "meta/main.yml should contain: {}".format(", ".join(info))
     severity = "HIGH"
     tags = ["metadata"]
     version_added = "v4.0.0"

src/ansiblelint/rules/risky_file_permissions.py

@@ -74,9 +74,9 @@ class MissingFilePermissionsRule(AnsibleLintRule):
         "permissions based "
         "on version of Ansible being used. Be explicit, like ``mode: 0644`` to "
         "avoid hitting this rule. Special ``preserve`` value is accepted "
-        f"only by {', '.join(_modules_with_preserve)} modules. "
-        "See https://github.com/ansible/ansible/issues/71200"
+        f"only by {', '.join(_modules_with_preserve)} modules."
     )
+    link = "https://github.com/ansible/ansible/issues/71200"
     severity = "VERY_HIGH"
     tags = ["unpredictability", "experimental"]
     version_added = "v4.3.0"

src/ansiblelint/rules/risky_octal.py

@@ -34,9 +34,9 @@ class OctalPermissionsRule(AnsibleLintRule):
     id = "risky-octal"
     description = (
         "Numeric file permissions without leading zero can behave "
-        "in unexpected ways. See "
-        "https://docs.ansible.com/ansible/latest/collections/ansible/builtin/file_module.html"
+        "in unexpected ways."
     )
+    link = "https://docs.ansible.com/ansible/latest/collections/ansible/builtin/file_module.html"
     severity = "VERY_HIGH"
     tags = ["formatting"]
     version_added = "historic"

src/ansiblelint/rules/role_name.py

@@ -45,10 +45,9 @@ class RoleNames(AnsibleLintRule):
     id = "role-name"
     description = (
         "Role names are now limited to contain only lowercase alphanumeric "
-        "characters, plus '_' and start with an alpha character. See "
-        "`developing collections <https://docs.ansible.com/ansible/devel/dev_guide/"
-        "developing_collections_structure.html#roles-directory>`_"
+        "characters, plus underline and start with an alpha character."
     )
+    link = "https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#roles-directory"
     severity = "HIGH"
     done: List[str] = []  # already noticed roles list
     tags = ["deprecations", "metadata"]