lib/json_pointer/evaluator.rb in json_schema-0.13.6 vs lib/json_pointer/evaluator.rb in json_schema-0.14.0

@@ -1,5 +1,10 @@
 module JsonPointer
+  # Evaluates a JSON pointer within a JSON document.
+  #
+  # Note that this class is designed to evaluate references across a plain JSON
+  # data object _or_ an instance of `JsonSchema::Schema`, so the constructor's
+  # `data` argument can be of either type.
   class Evaluator
     def initialize(data)
       @data = data
     end