cleanup: adds short description to disable goerr113 linter

This commit adds a short description with reason to disable the goerr113 linter. issue: ceph#1227 Signed-off-by: Yati Padia <[email protected]>
chenhuazhong · Mar 16, 2022 · 732ab13 · 732ab13
1 parent 525ff5d
commit 732ab13
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/scripts/golangci.yml.in b/scripts/golangci.yml.in
@@ -169,7 +169,11 @@ linters:
     - funlen
     - testpackage
     - exhaustivestruct
-    # TODO: enable goerr113, see: https://github.com/ceph/ceph-csi/issues/1227
+    # This requires extra addition of unnecessary code. Hence, we
+    # prefer to disable this linter. But, it can be enabled if we
+    # have better resolution. For more details check the
+    # issue below.
+    # see: https://github.com/ceph/ceph-csi/issues/1227
     - goerr113
     - forbidigo
     # TODO: enable gomoddirectives