Polish test-check/dmesg documentation (teemtee#2897)

The-Mule · Oct 14, 2024 · c7a8460 · c7a8460
1 parent ccee347
commit c7a8460
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/docs/scripts/generate-plugins.py b/docs/scripts/generate-plugins.py
@@ -20,6 +20,7 @@
 
 REVIEWED_PLUGINS: tuple[str, ...] = (
  'prepare/ansible',
+ 'test-checks/dmesg'
  )
 
 

diff --git a/docs/templates/plugins.rst.j2 b/docs/templates/plugins.rst.j2
@@ -58,7 +58,7 @@ Configuration
  {% if not actual_default %}
  Default: *not set*
  {% else %}
- Default: {% for default_item in actual_default %}``{{ default_item.pattern | default(default_item) }}`` {% endfor %}
+ Default: {% for default_item in actual_default %}``{{ default_item.pattern | default(default_item) }}``{% if not loop.last %}, {% endif %}{% endfor %}
  {% endif %}
  {% else %}
  {% set _ = LOGGER.warn("%s/%s.%s: could not render default value, '%s'" | format(STEP, PLUGIN_ID, field_name, actual_default)) %}

diff --git a/tmt/checks/dmesg.py b/tmt/checks/dmesg.py
@@ -38,6 +38,7 @@ class DmesgCheck(Check):
  output. If any of patterns is found, ``dmesg`` check will
  report ``fail`` result.
  """,
+ metavar='PATTERN',
  normalize=tmt.utils.normalize_pattern_list,
  exporter=lambda patterns: [pattern.pattern for pattern in patterns],
  serialize=lambda patterns: [pattern.pattern for pattern in patterns],