From 88c93bb81841aed1e80a1b2f5fe6601ddf66df2d Mon Sep 17 00:00:00 2001
From: Remco Haszing <remcohaszing@gmail.com>
Date: Tue, 4 Aug 2020 19:33:58 +0200
Subject: [PATCH] fix(`check-examples`): disable jsdoc/require-jsdoc

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.
---
 src/rules/checkExamples.js | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/rules/checkExamples.js b/src/rules/checkExamples.js
index 60d493df7..74d197b46 100644
--- a/src/rules/checkExamples.js
+++ b/src/rules/checkExamples.js
@@ -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,