fix documentation for strings query parameter #620

phetsims · Nov 9, 2017 · 93ef7f9 · 93ef7f9
1 parent 18cc4ec
commit 93ef7f9
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/js/initialize-globals.js b/js/initialize-globals.js
@@ -306,7 +306,10 @@
     showVisibleBounds: { type: 'flag' },
 
     /**
-     * override strings, value is JSON that is identical to string.json files
+     * Override translated strings.
+     * The value is encoded JSON of the form { "namespace.key":"value", "namespace.key":"value", ... }
+     * Example: { "PH_SCALE/logarithmic":"foo", "PH_SCALE/linear":"bar" }
+     * Encode the JSON in a browser console using: encodeURIComponent( JSON.stringify( value ) )
      */
     strings: {
       type: 'string',