diff --git a/.README/rules/require-description.md b/.README/rules/require-description.md index 68613c2eb..1d9e9f6ba 100644 --- 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 index 8df6f607d..8bf99ff3a 100644 --- 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. #### Options