docs(require-description): clarify implicit/explicit description

gajus · Jan 20, 2021 · 6b5e82d · 6b5e82d
1 parent 4fd1cc4
commit 6b5e82d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 10 deletions.
diff --git a/.README/rules/require-description.md b/.README/rules/require-description.md
@@ -2,11 +2,12 @@
 
 Requires that all functions have a description.
 
-* All functions must have an implicit description or have the option
-  `descriptionStyle` set to `tag`.
-* Every jsdoc block description (or description tag if `descriptionStyle` is
-  `"tag"`) must have a non-empty description that explains the purpose of the
-  method.
+* All functions must have an implicit description (e.g., text above tags) or
+  have the option `descriptionStyle` set to `tag` (requiring `@description`
+  (or `@desc` if that is set as your preferred tag name)).
+* Every jsdoc block description (or `@description` tag if `descriptionStyle`
+  is `"tag"`) must have a non-empty description that explains the purpose of
+  the method.
 
 #### Options
 

diff --git a/README.md b/README.md
@@ -8400,11 +8400,12 @@ export default (foo) => {
 
 Requires that all functions have a description.
 
-* All functions must have an implicit description or have the option
-  `descriptionStyle` set to `tag`.
-* Every jsdoc block description (or description tag if `descriptionStyle` is
-  `"tag"`) must have a non-empty description that explains the purpose of the
-  method.
+* All functions must have an implicit description (e.g., text above tags) or
+  have the option `descriptionStyle` set to `tag` (requiring `@description`
+  (or `@desc` if that is set as your preferred tag name)).
+* Every jsdoc block description (or `@description` tag if `descriptionStyle`
+  is `"tag"`) must have a non-empty description that explains the purpose of
+  the method.
 
 <a name="eslint-plugin-jsdoc-rules-require-description-options-18"></a>
 #### Options