Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
GÉANT Service Orchestrator
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
GÉANT Orchestration and Automation Team
GAP
GÉANT Service Orchestrator
Commits
9a34c8e7
Verified
Commit
9a34c8e7
authored
1 year ago
by
Karel van Klink
Browse files
Options
Downloads
Patches
Plain Diff
rework vale ignore rules, and add some rationale
parent
c39c2c8a
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!46
Feature/update documentation
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/vale/.vale.ini
+13
-3
13 additions, 3 deletions
docs/vale/.vale.ini
with
13 additions
and
3 deletions
docs/vale/.vale.ini
+
13
−
3
View file @
9a34c8e7
...
...
@@ -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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment