docs: note about exclude

posva · Mar 2, 2023 · 8b40329 · 8b40329
1 parent 0350501
commit 8b40329
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/options.ts b/src/options.ts
@@ -46,7 +46,8 @@ export interface ResolvedOptions {
   routesFolder: RoutesFolderOption[]
 
   /**
-   * Array of `picomatch` globs to ignore. Defaults to `[]`.
+   * Array of `picomatch` globs to ignore. Defaults to `[]`. Note the globs are relative to the `routesFolder`, so avoid
+   * writing something like `['src/pages']` as **it won't match anything**.
    */
   exclude: string[]