Update JSDoc example with | safe already applied

alphagov · Nov 30, 2023 · 18f545a · 18f545a
1 parent 283be0e
commit 18f545a
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/lib/filters/core-filters.js b/lib/filters/core-filters.js
@@ -10,9 +10,11 @@ runWhenEnvIsAvailable(() => {
     /**
      * Logs an object in the template to the console in the browser.
      *
-     * @example {{ "hello world" | log }}
-     * @example {{ "hello world" | log | safe }}  [for environments with autoescaping turned on]
-     * @param  {any} a - any type
+     * @example
+     * ```njk
+     * {{ "hello world" | log }}
+     * ```
+     * @param {any} a - any type
      * @returns {string} a script tag with a console.log call.
      */
     (a) => nunjucksSafe('<script>console.log(' + JSON.stringify(a, null, '\t') + ');</script>')