Skip to content

Commit b7c72e3

Browse files
committed
docs(require-description): clarify
1 parent 68a67b6 commit b7c72e3

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.README/rules/require-description.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
{"gitdown": "contents", "rootId": "require-description"}
44

5-
Requires that all functions have a description.
5+
Requires that all functions (or optionally other structures) with a JSDoc block
6+
have a description.
67

78
* All functions must have an implicit description (e.g., text above tags) or
89
have the option `descriptionStyle` set to `tag` (requiring `@description`

docs/rules/require-description.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
* [Passing examples](#user-content-require-description-passing-examples)
99

1010

11-
Requires that all functions have a description.
11+
Requires that all functions (or optionally other structures) with a JSDoc block
12+
have a description.
1213

1314
* All functions must have an implicit description (e.g., text above tags) or
1415
have the option `descriptionStyle` set to `tag` (requiring `@description`

0 commit comments

Comments
 (0)