Skip to content

Commit 0ef73eb

Browse files
bgrozevgajus
authored andcommitted
docs: fixes the require-description-complete-sentence docs (#58)
Updates the documentation to match the [code](https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/rules/requireDescriptionCompleteSentence.js#L82). Notably, the doc used to say "lowercase" while the code is looking for "uppercase".
1 parent 0e6b80e commit 0ef73eb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Requires that block description and tag description are written in complete sentences, i.e.,
44

55
* Description must start with an uppercase alphabetical character.
6-
* Paragraph must start with an uppercase alphabetical character.
6+
* Paragraphs must start with an uppercase alphabetical character.
77
* Sentences must end with a period.
8-
* Every line that starts with a lowercase character must be preceded by a line ending the sentence.
8+
* Every line in a paragraph (except the first) which starts with an uppercase character must be preceded by a line ending with a period.
99

1010
|||
1111
|---|---|

0 commit comments

Comments
 (0)