]> gitweb.factorcode.org Git - factor.git/commitdiff
json.writer: Updated docs to mention the dynamic variable jsvar-encode?
authorotoburb <otoburb@gmail.com>
Tue, 5 Jul 2011 04:07:59 +0000 (00:07 -0400)
committerotoburb <otoburb@gmail.com>
Tue, 5 Jul 2011 04:07:59 +0000 (00:07 -0400)
basis/json/writer/writer-docs.factor

index 9a6ba5f2b1f3efab2032e183956245db731564bc..6445f0a7cb814dbcc64bc99c63d3869d743b3ea4 100644 (file)
@@ -10,7 +10,9 @@ HELP: >json
 
 HELP: json-print
 { $values { "obj" "an object" } }
-{ $description "Serializes the object into a JSON formatted string and outputs it to the standard output stream." } 
+{ $description "Serializes the object into a JSON formatted string and outputs it to the standard output stream. 
+
+By default, tuples and hashtables are serialized into Javascript-friendly JSON formatted output by converting keys containing dashes into underscores. This behaviour can be modified by setting the dynamic variable " { $strong "jsvar-encode?" } " to false." } 
 { $see-also >json } ;
 
 ARTICLE: "json.writer" "JSON writer"