docs(require-description): clarify

gajus · Jun 25, 2023 · 42a97c8 · 42a97c8
1 parent 1b9d9e4
commit 42a97c8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.README/rules/require-description.md b/.README/rules/require-description.md
@@ -2,7 +2,8 @@
 
 {"gitdown": "contents", "rootId": "require-description"}
 
-Requires that all functions have a description.
+Requires that all functions (or optionally other structures) with a JSDoc block
+have a description.
 
 * All functions must have an implicit description (e.g., text above tags) or
   have the option `descriptionStyle` set to `tag` (requiring `@description`

diff --git a/docs/rules/require-description.md b/docs/rules/require-description.md
@@ -8,7 +8,8 @@
 * [Passing examples](#user-content-require-description-passing-examples)
 
 
-Requires that all functions have a description.
+Requires that all functions (or optionally other structures) with a JSDoc block
+have a description.
 
 * All functions must have an implicit description (e.g., text above tags) or
   have the option `descriptionStyle` set to `tag` (requiring `@description`