Skip to content

Commit

Permalink
fix(check-examples): disable jsdoc/require-jsdoc
Browse files Browse the repository at this point in the history
Examples inside JSDoc comments cant comply with the `jsdoc/require-jsdoc` rule,
because the closing comment of the nested JSDoc would close the multiline
comment that contains the example.
  • Loading branch information
remcohaszing authored and brettz9 committed Aug 5, 2020
1 parent 86af2c9 commit 88c93bb
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/rules/checkExamples.js
Expand Up @@ -94,6 +94,9 @@ export default iterateJsdoc(({
// Snippets likely too short to always include import/export info
'import/unambiguous': 0,

// The end of a multiline comment would end the comment the example is in.
'jsdoc/require-jsdoc': 0,

// Unlikely to have inadvertent debugging within examples
'no-console': 0,

Expand Down

0 comments on commit 88c93bb

Please sign in to comment.