docs improvement

chris48s · Aug 19, 2024 · daca1a8 · daca1a8
1 parent 6a84091
commit daca1a8
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/plugins.js b/src/plugins.js
@@ -198,8 +198,12 @@ async function loadAllPlugins(userPlugins) {
 
 /**
  * @typedef {object} ValidationResult
- * @property {string} fileLocation - Filename of the document that was
- *   validated.
+ * @property {string} fileLocation - Path of the document that was validated.
+ *   Filenames are resolved and normalised by
+ *   [glob](https://www.npmjs.com/package/glob) using the `dotRelative` option.
+ *   This means relative paths in the current directory will be prefixed with
+ *   `./` (or `.\` on Windows) even if this was not present in the input
+ *   filename or pattern.
  * @property {string | null} schemaLocation - Location of the schema used to
  *   validate this file if one could be found. `null` if no schema was found.
  * @property {boolean | null} valid - Result of the validation (true/false) if a