Skip to content

Commit 9d9b5c5

Browse files
authored
Update docs to include help for jsdoc warnings
1 parent dcaeb6d commit 9d9b5c5

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,10 @@ Or disable BOTH the desired rule and the no-eslint-disable rule:
126126

127127
This is a known state when submitting a new file to Code Climate for the first time, since they do not support all of the linting extensions we wish to use. If you are seeing these warnings when linting locally, you likely have `eslint` installed globally, but not the additional dependency. We do not recommend running `eslint` globally for this reason (see: https://github.com/eslint/eslint/issues/6732). All Tree repositories should include all dependencies required to be able to run `eslint` locally in their respective directories.
128128

129+
### How to not have tons of `jsdoc` warnings:
130+
131+
The `jsdoc` warnings are only triggered for functions that have an jsdoc extended comment block (`/** */`) directly above the function declaration. Omit this, or just use a short comment (`//`) or a standard extended comment (`/* */`) to keep from applying `jsdoc` rules to functions not requiring fastidious documentation. Or follow all of the rules.
132+
129133
### How to do even trickier things with linting configuration:
130134

131135
Just read the manual: https://eslint.org/docs/7.0.0/user-guide/configuring

0 commit comments

Comments
 (0)