Skip to content
Snippets Groups Projects

Feature/update documentation

Merged Karel van Klink requested to merge feature/update-documentation into develop
1 file
+ 13
3
Compare changes
  • Side-by-side
  • Inline
+ 13
3
@@ -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
Loading