git: 6729b16b7b - main - vale/styles: Remove Weasel rule
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Thu, 11 May 2023 14:09:56 UTC
The branch main has been updated by bofh: URL: https://cgit.FreeBSD.org/doc/commit/?id=6729b16b7ba504e7ae967333153472632d9b2c1c commit 6729b16b7ba504e7ae967333153472632d9b2c1c Author: Muhammad Moinur Rahman <bofh@FreeBSD.org> AuthorDate: 2023-05-11 14:07:49 +0000 Commit: Muhammad Moinur Rahman <bofh@FreeBSD.org> CommitDate: 2023-05-11 14:09:44 +0000 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 --- .vale.ini | 1 - .vale/styles/FreeBSD/Weasel.yml | 206 --------------------- .../en/books/fdp-primer/writing-style/_index.adoc | 7 - 3 files changed, 214 deletions(-) diff --git a/.vale.ini b/.vale.ini index 2ce1390bf8..e7657b17a3 100644 --- a/.vale.ini +++ b/.vale.ini @@ -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 diff --git a/.vale/styles/FreeBSD/Weasel.yml b/.vale/styles/FreeBSD/Weasel.yml deleted file mode 100644 index 12b74d76ef..0000000000 --- a/.vale/styles/FreeBSD/Weasel.yml +++ /dev/null @@ -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 diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc index 8d0161fb81..935025d090 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc @@ -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.