From 4772aa70c6d88ead3b04e60490ce0e6a574c08aa Mon Sep 17 00:00:00 2001
From: Sabir Hassan <sabirbk06@gmail.com>
Date: Fri, 12 Aug 2022 15:59:58 +0500
Subject: [PATCH] chore: update jsdoc header

---
 src/utils/isIgnored.ts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/utils/isIgnored.ts b/src/utils/isIgnored.ts
index 9c50942..9a36782 100644
--- a/src/utils/isIgnored.ts
+++ b/src/utils/isIgnored.ts
@@ -5,6 +5,7 @@ import { getLintConfig, getProjectRoot } from '.'
 import { LintConfig } from '../types'
 
 /**
+ * A function to check if file/folder path matches any pattern from .gitignore or ignoreList (.sasjsLint)
  *
  * @param fPath absolute path of file or folder
  * @returns {Promise<boolean>} true if path matches the patterns from .gitignore file otherwise false