doc: Document for #3

zealic · Oct 8, 2021 · 7a7856c · 7a7856c
1 parent fe0a09f
commit 7a7856c
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/matcher.go b/matcher.go
@@ -22,7 +22,7 @@ func NewSystemMatcher() *Matcher {
 	return &Matcher{afero.NewReadOnlyFs(afero.NewOsFs())}
 }
 
-// Matches returns matched files from dir files.
+// Matches returns matched files from dir files, basedir not support relative path, eg './foo/bar'.
 func (m *Matcher) Matches(basedir string, options *MatchesOptions) (*MatchesResult, error) {
 	vfs := afero.NewBasePathFs(m.fs, basedir)
 	ignorefile := options.Ignorefile