README.md: improve the usage of isPathValid

kaelzhang · May 22, 2020 · 890c00f · 890c00f
1 parent d5b5b8f
commit 890c00f
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -310,7 +310,9 @@ ig.ignores('*.PNG')  // false
 
 ## static `ignore.isPathValid(pathname): boolean` since 5.0.0
 
-Check whether the `pathname` is valid according to the [convention](#1-pathname-should-be-a-pathrelatived-pathname).
+Check whether the `pathname` is an valid `path.relative()`d path according to the [convention](#1-pathname-should-be-a-pathrelatived-pathname).
+
+This method is **NOT** used to check if an ignore pattern is valid.
 
 ```js
 ignore.isPathValid('./foo')  // false