Page MenuHomeFreeBSD

fdp-primer/writing-style: Refactor after adding new Vale rules
ClosedPublic

Authored by bofh on Apr 25 2023, 12:39 PM.
Tags
None
Referenced Files
Unknown Object (File)
Apr 27 2024, 9:47 AM
Unknown Object (File)
Apr 27 2024, 9:47 AM
Unknown Object (File)
Apr 27 2024, 8:34 AM
Unknown Object (File)
Apr 27 2024, 8:18 AM
Unknown Object (File)
Apr 27 2024, 7:35 AM
Unknown Object (File)
Dec 23 2023, 12:17 AM
Unknown Object (File)
Aug 28 2023, 7:56 AM
Unknown Object (File)
Jun 20 2023, 4:44 PM
Subscribers
None

Details

Summary

Over the last couple of day some new rules has been added, while some rules have been replaced with the one from Vale builtin engines and some have been removed.

  • Update the fdp-primer to reflect those changes.
  • As now there are mix of two different styles FreeBSD and Vale be more specific on naming those rules with dotted notation.
  • Reword the rule FreeBSD.ConsciousLanguage by avoiding sensitive words itself.
Test Plan

Diff Detail

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

Event Timeline

bofh requested review of this revision.Apr 25 2023, 12:39 PM
bofh created this revision.

A couple of minor corrections and additions. It's good to have this documented in the FDP, thanks!

documentation/content/en/books/fdp-primer/writing-style/_index.adoc
315

s/every//
s/Companies/companies/

320

s/personnel/people/
s/avoided./avoided where possible./

332

s/on/by the/

Fix the minor changes mentioned by @bcr

bofh marked 3 inline comments as done.Apr 25 2023, 2:18 PM

Updated accordingly.

Thanks @bofh.

documentation/content/en/books/fdp-primer/writing-style/_index.adoc
341

s/not be n/not be in/

Sorry for the delay, if this happens again, ping me by email

This revision is now accepted and ready to land.May 2 2023, 6:38 PM