Skip to content

Commit 4042eab

Browse files
committed
docs(require-description-complete-sentence): update per backtick addition
1 parent cbec35f commit 4042eab

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.README/rules/require-description-complete-sentence.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Requires that block description, explicit `@description`, and
55

66
* Description must start with an uppercase alphabetical character.
77
* Paragraphs must start with an uppercase alphabetical character.
8-
* Sentences must end with a period.
8+
* Sentences must end with a period, question mark, exclamation mark, or triple backticks.
99
* Every line in a paragraph (except the first) which starts with an uppercase
1010
character must be preceded by a line ending with a period.
1111
* A colon or semi-colon followed by two line breaks is still part of the
1212
containing paragraph (unlike normal dual line breaks).
13-
* Text within inline tags `{...}` are not checked for sentence divisions.
13+
* Text within inline tags `{...}` or within triple backticks are not checked for sentence divisions.
1414
* Periods after items within the `abbreviations` option array are not treated
1515
as sentence endings.
1616

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10911,12 +10911,12 @@ Requires that block description, explicit `@description`, and
1091110911

1091210912
* Description must start with an uppercase alphabetical character.
1091310913
* Paragraphs must start with an uppercase alphabetical character.
10914-
* Sentences must end with a period.
10914+
* Sentences must end with a period, question mark, exclamation mark, or triple backticks.
1091510915
* Every line in a paragraph (except the first) which starts with an uppercase
1091610916
character must be preceded by a line ending with a period.
1091710917
* A colon or semi-colon followed by two line breaks is still part of the
1091810918
containing paragraph (unlike normal dual line breaks).
10919-
* Text within inline tags `{...}` are not checked for sentence divisions.
10919+
* Text within inline tags `{...}` or within triple backticks are not checked for sentence divisions.
1092010920
* Periods after items within the `abbreviations` option array are not treated
1092110921
as sentence endings.
1092210922

0 commit comments

Comments
 (0)