Audit the number of Vale warnings and suggestions in the docs
Docs linting warnings and suggestions
Related to #378718 (closed)
This is an audit of the warnings and suggestions reported by the various vale rules, in an effort to judge whether or not any config needs to change. Data for Nov 2022:
Rule | Error | Warning | Suggestion | Proposal |
---|---|---|---|---|
AlertBoxStyle.yml |
0 | |||
BadgeCapitalization.yml |
0 | |||
BadPlurals.yml |
0 | |||
British.yml |
0 | |||
CIConfigFile.yml |
0 | |||
CodeblockFences.yml |
0 | |||
CurlStringsQuoted.yml |
0 | |||
CurrentStatus.yml |
460 | Move to warning (KP) Consider removing the yet component of this rule, as it returns many false positives |
||
DefaultBranch.yml |
46 | (KP) Would be nice to have this as part of InclusionCultural.yml , and remove this one. But there might be technical limitations. |
||
Dropdown.yml |
4 | |||
ElementDescriptors.yml |
294 | Move to warning (Selhorn) The only descriptor we currently have in this rule is button , and there are times button is a valid word. Can we update the rule to check for a bold word before the word button ? Also, the language in the error message is strange and should be shortened. |
||
EOLWhitespace.yml |
38 | |||
FirstPerson.yml |
95 | |||
FutureTense.yml |
1441 | |||
HeadingContent.yml |
106 | |||
HeadingDepth.yml |
288 | Move to suggestion. Requires structural editing, hard to do in an MR | ||
InclusionAbleism.yml |
2 | Move to warning | ||
InclusionCultural.yml |
17 | |||
InclusionGender.yml |
3 | Move to warning | ||
InternalLinkCase.yml |
0 | |||
InternalLinkExtension.yml |
0 | |||
InternalLinkFormat.yml |
0 | |||
LatinTerms.yml |
15 | |||
Markdown_emoji.yml |
0 | |||
MeaningfulLinkWords.yml |
2 | |||
MergeConflictMarkers.yml |
0 | |||
MultiLineLinks.yml |
0 | |||
NonStandardQuotes.yml |
28 | |||
OutdatedVersions.yml |
826 | Keep at suggestion | ||
OxfordComma.yml |
131 | |||
Possessive.yml |
0 | |||
ReadingLevel.yml |
1646 | Keep at suggestion | ||
ReferenceLinks.yml |
0 | |||
RelativeLinks.yml |
0 | |||
RelativeLinksDoubleSlashes.yml |
0 | |||
Repetition.yml |
0 | |||
SentenceLength.yml |
5401 | (KP) This seems like an extremely high number of warnings. Is it possible we're returning false positives? Move to suggestion. There are so many warnings, they are often ignored. |
||
SentenceSpacing.yml |
0 | |||
Simplicity.yml |
600 | Move to warning? | ||
Spelling.yml |
|
|||
Substitutions.yml |
0 | |||
SubstitutionSuggestions.yml |
1568 |
|
||
SubstitutionWarning.yml |
179 | See above. | ||
ToDo.yml |
0 | |||
UnclearAntecedent.yml |
1121 | |||
Units.yml |
286 | Move to warning | ||
Uppercase.yml |
554 | Move to suggestion. Often requires updating the exception list, which is adds to scope and complexity of MR | ||
VersionText.yml |
0 | |||
VersionTextSingleLine.yml |
0 | |||
Wordy.yml |
580 |
Ideas:
-
Have two sentence Length rules. One at warning level for contributors, for 30+ words. One at suggestion level for TWs, at 25+ words:
- 25+ words: 3755
- 30+ words: 1547
Comments:
- Annotations help MR authors improve their contributions, but some can be hard (25 words, unclear antecedent, etc)
- Adding the more difficult annotations could increase pressure on contributors to try to fix complicated language issue, but they are extremely useful for TWs. The annotations highlight important spots for the TW to take a closer look at.
Edited by Kati Paizee