Skip to content

Commit

Permalink
docs(require-description-complete-sentence): update per backtick ad…
Browse files Browse the repository at this point in the history
…dition
  • Loading branch information
brettz9 committed Jan 31, 2023
1 parent cbec35f commit 4042eab
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .README/rules/require-description-complete-sentence.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 4042eab

Please sign in to comment.