Document that the json plugin does not support treating String, False…

…Class, NilClass values as JSON (Fixes #329)
jeremyevans · Aug 8, 2023 · f7c2752 · f7c2752
1 parent 44a7e0e
commit f7c2752
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/roda/plugins/json.rb b/lib/roda/plugins/json.rb
@@ -52,6 +52,9 @@ module RodaPlugins
     # using the +:content_type+ option:
     #
     #   plugin :json, content_type: 'application/xml'
+    #
+    # This plugin depends on the custom_block_results plugin, and therefore does
+    # not support treating String, FalseClass, or NilClass values as JSON.
     module Json
       # Set the classes to automatically convert to JSON, and the serializer to use.
       def self.configure(app, opts=OPTS)