forked from mesa/mesa
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.vale.ini
More file actions
38 lines (33 loc) · 1.74 KB
/
.vale.ini
File metadata and controls
38 lines (33 loc) · 1.74 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
StylesPath = .github/styles
MinAlertLevel = suggestion
Packages = Google
[docs/**/*.{md,rst}]
# Only apply Vale to the docs/ folder
BasedOnStyles = Google, Mesa
Mesa.Branding = error
# --- DISABLE RULES ---
Vale.Spelling = NO # Disable Spelling (MESA uses codespell)
Google.Acronyms = NO # Technical docs have many acronyms (MIT, ASCII, SIR, etc.)
Google.Colons = NO # Capitalization after colons is flexible in technical docs
Google.Contractions = NO # Don't force contractions in technical docs
Google.Ellipses = NO # Sometimes appropriate in documentation
Google.EmDash = suggestion # Style preference
Google.Exclamation = NO
Google.FirstPerson = NO
Google.Latin = suggestion # e.g., i.e. are common in technical writing
Google.LyHyphens = suggestion # Hyphenation rules can be context-dependent
Google.OxfordComma = suggestion # Style preference, not an error
Google.Parens = NO # Disable Parentheses checks
Google.Passive = NO # Disable Passive voice
Google.Quotes = suggestion # American vs British style
Google.Semicolons = NO # Semicolons are fine in technical writing
Google.We = NO
Google.Will = NO # Disable Future tense
# --- Enable this rules later if needed ---
Google.DateFormat = NO # Different formats are acceptable
Google.GenderBias = suggestion # Handle these case-by-case
Google.Headings = NO # Disable Heading Capitalization
Google.OptionalPlurals = NO # Author(s) is fine
Google.Spacing = NO # Can have false positives with code/formulas
Google.Units = suggestion # Technical docs may have different unit formatting
Google.WordList = suggestion # "functionality" is acceptable in technical contexts