DOCPR-373: rule no. 003 correct use of Ubuntu versions

AnneCYH commented 4 weeks ago

PR for DOCPR-373 to address rule no. 003, correct use of Ubuntu versions. I don't have examples of what are common incorrect uses; hence am just making assumptions about the incorrect scenarios.

The list of releases are checked until 18.04 since the rest are historically very old versions already. This is due to the current regex definition which is not too flexible in terms of versions that are being detected (to be more accurate).

Also there is only 1 version of the test file (in MD) since for this rule, the syntax for RST vs MD is irrelevant.

Thanks.

AnneCYH commented 4 weeks ago

@keirthana , thanks for the review! I've added the example in the output 'suggestion' message and added the same naming style to the style guide itself.

evilnick commented 3 weeks ago

This is really great - it goes beyond what i thought we would be able to do. I have tweaked a few things

scope: I think we overuse the 'raw' scope which tends to throw up false positives. I tweaked it here and it still matches the tests
test: I expanded the test to include a heading and a table to check the scope was working

evilnick commented 3 weeks ago

sorry @keirthana, could you +1 this again if you agree?

canonical / praecepta

DOCPR-373: rule no. 003 correct use of Ubuntu versions #31