Improve Oxford comma check
What does this MR do?
In this MR:
- Improves the regex for catching Oxford comma. It sometimes flags, not a lack of Oxford comma, but an overly complex sentence structure.
- This does change the bar for error above a three-item list, requiring four items for it to be flagged. This allows for sentence constructions that look like a list requiring a comma, but aren't. For example,
for example, item 1 and item 2
. - Instances of the error in
doc/administrator
have been resolved, either by adding an Oxford comma or rewriting text.
This takes us down the path of eventually enforcing this long established standard.
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖