Page MenuHomeFreeBSD

vale/style: Utilize vales vocabulary engine
ClosedPublic

Authored by bofh on Apr 19 2023, 7:36 PM.
Tags
None
Referenced Files
Unknown Object (File)
Jan 27 2024, 2:45 AM
Unknown Object (File)
Jan 27 2024, 2:45 AM
Unknown Object (File)
Jan 27 2024, 2:45 AM
Unknown Object (File)
Jan 27 2024, 2:37 AM
Unknown Object (File)
Dec 20 2023, 6:52 AM
Unknown Object (File)
Nov 30 2023, 5:49 AM
Unknown Object (File)
Nov 30 2023, 5:49 AM
Unknown Object (File)
Nov 30 2023, 5:49 AM
Subscribers
None

Details

Summary
  • Remove spelling-exceptions list
  • Vale has it's own engine to add custom vocabulary for adding project specific keywords. Add a vocabulary named Terms
  • Add the file accept.txt which words should be accepted without any errors
  • Utilize documentation/content/en/books/arch-handbook/mac/_index.adoc as proof of concept to remove all sort of errors/warnings/suggestion.
    • Remove EOLSpace
    • Fix Semantic Line Breakings
    • Add relevant keywords to the new Vocab file accept.txt
    • Some codewords were not marked with single tick ` so mark those properly that spelling engine do not throw errors
    • Currently it looks like we have too many Weasel words. I am not sure whether if we should keep this Rule or not. I did not touch any warnings related to Weasel errors on this file

If I am allowed blanket approval for fixing these technical errors/suggestions I can really fix these and reduce the noise. Otherwise it's difficult to put this into action for our CI pipeline as it will create lots of noises.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

bofh requested review of this revision.Apr 19 2023, 7:36 PM
bofh created this revision.

ACK, I'll take a look this night

Works for me, approved.
Thanks for your work on this.

I'll send an email to bcr@ and you about this kind of changes

PS: Sorry for the *big* delay

This revision is now accepted and ready to land.May 2 2023, 6:39 PM
This revision was automatically updated to reflect the committed changes.