From 9a34c8e7c471d64ddb8fbf483fe4fc9698b61ae9 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 12 Jul 2023 10:45:42 +0200
Subject: [PATCH] rework vale ignore rules, and add some rationale

---
 docs/vale/.vale.ini | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini
index e01a77fe..ac159ef1 100644
--- a/docs/vale/.vale.ini
+++ b/docs/vale/.vale.ini
@@ -9,14 +9,24 @@ Packages = proselint, Microsoft
 [*.{md,py}]
 ; We only lint .md and .py files
 BasedOnStyles = Vale, proselint, Microsoft
+; Some headers are generated and we have no real influence over them
 Microsoft.Headings = NO
+; Found to be too intrusive
+Microsoft.Passive = NO
+; We are not a general audience
+Microsoft.GeneralURL = NO
+; It's okay to leave TODOs in the code, that's what they're for
+proselint.Annotations = NO
+; Replacing a ... with … shouldn't be holding back the entire CI pipeline
+proselint.Typography = warning
+; Same applies for not using contractions
+Microsoft.Contractions = warning
 
-TokenIgnores = (?:{term}`\S+`)
+TokenIgnores = ({term}), (:param \S+:), (:type \S+:)
 
 [*/glossary.md]
 ; Ignore acronyms being undefined in the file that defines all acronyms by definition.
 Microsoft.Acronyms = NO
 
 [formats]
-; Ignore inline comments in source code, as these do not show up in generated documentation.
-py = rst
+py = md
-- 
GitLab