1
0
mirror of https://git.FreeBSD.org/doc.git synced 2026-06-02 19:35:07 +00:00

vale/styles: Remove Weasel rule

After some careful consideration and thoughts the Weasel rule is being
removed because currently there are 18805 suggestions which will be
really time consuming to fix as rewording the sentences from weasel
words are a bit complicated.

Approved by:	bcr (mentor)
Differential Revision:	https://reviews.freebsd.org/D40063
This commit is contained in:
Muhammad Moinur Rahman
2023-05-11 16:07:49 +02:00
parent db5022b3cf
commit 6729b16b7b
3 changed files with 0 additions and 214 deletions
-1
View File
@@ -24,7 +24,6 @@ FreeBSD.Pronouns = NO
FreeBSD.SuperfluousOptArgInLinks = NO
FreeBSD.SemanticLineBreak = NO
FreeBSD.Spacing = NO
FreeBSD.Weasel = NO
Vale.Avoid= NO
Vale.Repetition = NO
Vale.Spelling = NO
-206
View File
@@ -1,206 +0,0 @@
---
extends: existence
message: "'%s' is a weasel word!"
ignorecase: true
level: suggestion
tokens:
- absolutely
- accidentally
- additionally
- allegedly
- alternatively
- angrily
- anxiously
- approximately
- awkwardly
- badly
- barely
- beautifully
- blindly
- boldly
- bravely
- brightly
- briskly
- bristly
- bubbly
- busily
- calmly
- carefully
- carelessly
- cautiously
- cheerfully
- clearly
- closely
- coldly
- completely
- consequently
- correctly
- courageously
- crinkly
- cruelly
- crumbly
- cuddly
- currently
- daily
- daringly
- deadly
- definitely
- deliberately
- doubtfully
- dumbly
- eagerly
- early
- easily
- elegantly
- enormously
- enthusiastically
- equally
- especially
- eventually
- exactly
- exceedingly
- exclusively
- extremely
- fairly
- faithfully
- fatally
- fiercely
- finally
- fondly
- few
- foolishly
- fortunately
- frankly
- frantically
- generously
- gently
- giggly
- gladly
- gracefully
- greedily
- happily
- hardly
- hastily
- healthily
- heartily
- helpfully
- honestly
- hourly
- hungrily
- hurriedly
- immediately
- impatiently
- inadequately
- ingeniously
- innocently
- inquisitively
- interestingly
- irritably
- jiggly
- joyously
- justly
- kindly
- largely
- lately
- lazily
- likely
- literally
- lonely
- loosely
- loudly
- loudly
- luckily
- madly
- many
- mentally
- mildly
- mortally
- mostly
- mysteriously
- neatly
- nervously
- nightly
- noisily
- normally
- obediently
- occasionally
- only
- openly
- painfully
- particularly
- patiently
- perfectly
- politely
- poorly
- powerfully
- presumably
- previously
- promptly
- punctually
- quickly
- quietly
- rapidly
- rarely
- really
- recently
- recklessly
- regularly
- remarkably
- relatively
- reluctantly
- repeatedly
- rightfully
- roughly
- rudely
- sadly
- safely
- selfishly
- sensibly
- seriously
- sharply
- shortly
- shyly
- significantly
- silently
- simply
- sleepily
- slowly
- smartly
- smelly
- smoothly
- softly
- solemnly
- sparkly
- speedily
- stealthily
- sternly
- stupidly
- substantially
- successfully
- suddenly
- surprisingly
- suspiciously
- swiftly
- tenderly
- tensely
- thoughtfully
- tightly
- timely
- truthfully
- unexpectedly
- unfortunately
- usually
- very
- victoriously
- violently
- vivaciously
- warmly
- waverly
- weakly
- wearily
- weekly
- wildly
- wisely
- worldly
- wrinkly
- yearly
@@ -287,9 +287,6 @@ The following table describes the current rule names and their respective severi
| FreeBSD.SuperfluousOptArgInLinks
| suggestion
| FreeBSD.Weasel
| warning
| Vale.Avoid
| error
@@ -328,10 +325,6 @@ This rule proposes better wording.
. FreeBSD.SuperfluousOptArgInLinks: Suggest to empty square brackets in `link:` macros when the displayed text coincides with the URL.
. FreeBSD.Weasel: This rule is aimed at avoiding weasel words.
The concept of weasel words is controversial so at the moment the list of words are being evaluated and the severity level is marked as warning only.
If a frequently used word is marked as a weasel word it should be removed from [.filename]#.vale/styles/FreeBSD/Weasel.yml# in the `doc` repository.
. Vale.Avoid: Enforces the *DO NOT USE* vocabulary terms for The FreeBSD Project.
If any word is found that should not be n the documentation the word should be added to the [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository.
The list is empty at the moment.