diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini index e01a77fe6d830336af239736c443c88d7c387773..ac159ef1d50a483815e04a6772174caf13b7efb6 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