Skip to content

Commit 890c00f

Browse files
committed
README.md: improve the usage of isPathValid
1 parent d5b5b8f commit 890c00f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,9 @@ ig.ignores('*.PNG') // false
310310

311311
## static `ignore.isPathValid(pathname): boolean` since 5.0.0
312312

313-
Check whether the `pathname` is valid according to the [convention](#1-pathname-should-be-a-pathrelatived-pathname).
313+
Check whether the `pathname` is an valid `path.relative()`d path according to the [convention](#1-pathname-should-be-a-pathrelatived-pathname).
314+
315+
This method is **NOT** used to check if an ignore pattern is valid.
314316

315317
```js
316318
ignore.isPathValid('./foo') // false

0 commit comments

Comments
 (0)