search

canonical / praecepta

Creative Commons Attribution Share Alike 4.0 International
11 stars 15 forks source link

DOCPR-371: Vale rule no. 01 British English check #28

Closed AnneCYH closed 1 month ago

AnneCYH commented 1 month ago

Hi @evilnick , @SecondSkoll ,

This PR is for DOCPR-371.

This rule is focused only on making suggestions for words using US spelling, to UK English spelling. Style guide section: https://docs.ubuntu.com/styleguide/en/#spelling

I think it'll be better to create separate rules for common technology terms we want to standardise, e.g. "website" and not "web site". That would be cleaner to maintain and test. [Update: I just realised this is indeed a separate rule in the style guide source itself.]

I also think it would be good to start following a proper naming convention for the test files we include. E.g. for rule no. 011, the test file name would be test011.md or test011.rst, so we know which rules are expected to fail.

Thanks!

SecondSkoll commented 1 month ago

Also, I thought the same about the tests - the tests I introduced follow the convention you suggested :)

evilnick commented 1 month ago

Nice work - I think if you just remove the contentious ones this should be good to go ;)

AnneCYH commented 1 month ago

Thanks @SecondSkoll and @evilnick !

I'll remove the contentious ones and squash the commits. I've removed the contentious words and squashed the commits.

Thanks!