From bce22ce46d2370011d594fd3306f7c9dc495bc32 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=94=AF=E5=88=83?= <weiren@dian.so>
Date: Wed, 8 Apr 2020 19:03:59 +0800
Subject: [PATCH] Chore: add a comment

---
 .eslintrc.js | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.eslintrc.js b/.eslintrc.js
index 96140560a59f..f05fa56ed859 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -53,6 +53,12 @@ module.exports = {
     parserOptions: {
         ecmaVersion: 2020
     },
+
+    /*
+     * it fixes eslint-plugin-jsdoc's reports: "Invalid JSDoc tag name "template" jsdoc/check-tag-names"
+     * as we are using tag template
+     * refs: see https://github.com/gajus/eslint-plugin-jsdoc#check-tag-names
+     */
     settings: {
         jsdoc: {
             mode: "typescript"