summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab/AlertBoxStyle.yml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/.vale/gitlab/AlertBoxStyle.yml')
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml3
1 files changed, 1 insertions, 2 deletions
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml
index 78db7fa99ae..92c3a16cab8 100644
--- a/doc/.vale/gitlab/AlertBoxStyle.yml
+++ b/doc/.vale/gitlab/AlertBoxStyle.yml
@@ -1,9 +1,8 @@
---
# Error: gitlab.AlertBoxStyle
#
-# Makes sure alert boxes are used with block quotes.
+# Makes sure alert boxes are used with block quotes. Checks for 3 formatting issues:
#
-# Checks for 3 formatting issues:
# - Alert boxes inside a block quote (">")
# - Alert boxes with the note text on the same line
# - Alert boxes using words other than "NOTE" or "WARNING"