diff --git a/.README/rules/require-description-complete-sentence.md b/.README/rules/require-description-complete-sentence.md index de40b123a..ef0875c4a 100644 --- a/.README/rules/require-description-complete-sentence.md +++ b/.README/rules/require-description-complete-sentence.md @@ -5,12 +5,12 @@ Requires that block description, explicit `@description`, and * Description must start with an uppercase alphabetical character. * Paragraphs must start with an uppercase alphabetical character. -* Sentences must end with a period. +* Sentences must end with a period, question mark, exclamation mark, or triple backticks. * Every line in a paragraph (except the first) which starts with an uppercase character must be preceded by a line ending with a period. * A colon or semi-colon followed by two line breaks is still part of the containing paragraph (unlike normal dual line breaks). -* Text within inline tags `{...}` are not checked for sentence divisions. +* Text within inline tags `{...}` or within triple backticks are not checked for sentence divisions. * Periods after items within the `abbreviations` option array are not treated as sentence endings. diff --git a/README.md b/README.md index 3899b1ee7..d8e32c438 100644 --- a/README.md +++ b/README.md @@ -10911,12 +10911,12 @@ Requires that block description, explicit `@description`, and * Description must start with an uppercase alphabetical character. * Paragraphs must start with an uppercase alphabetical character. -* Sentences must end with a period. +* Sentences must end with a period, question mark, exclamation mark, or triple backticks. * Every line in a paragraph (except the first) which starts with an uppercase character must be preceded by a line ending with a period. * A colon or semi-colon followed by two line breaks is still part of the containing paragraph (unlike normal dual line breaks). -* Text within inline tags `{...}` are not checked for sentence divisions. +* Text within inline tags `{...}` or within triple backticks are not checked for sentence divisions. * Periods after items within the `abbreviations` option array are not treated as sentence endings.