doc: document variables referencing schemas in code

ExodusMovement · Nov 30, 2023 · faddd1e · faddd1e
1 parent e3224b1
commit faddd1e
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/compile.js b/src/compile.js
@@ -75,6 +75,16 @@ const generateMeta = (root, $schema, enforce, requireSchema) => {
   }
 }
 
+/*
+  Variables referencing schemas:
+   1. `root` -- top-level schema, entry point
+   2. `schema` -- portion of the schema currently being compiled to a separate function,
+      i.e. top-level or referenced ($ref/etc)
+   3. `node` (defined in visit()) -- schema object being visited by visit()
+   4. `schemas` aka `opts.schemas` -- a Map() of sibling schemas that could be referenced by
+      their $id (and optionally subreferenced via json pointer path)
+*/
+
 const compileSchema = (schema, root, opts, scope, basePathRoot = '') => {
   const {
     mode = 'default',