Browse Source

Fixed #34595 -- Doc'd that format_string arg of format_html() is not escaped.

AP Jama 1 year ago
parent
commit
4037223d0f
1 changed files with 3 additions and 1 deletions
  1. 3 1
      docs/ref/utils.txt

+ 3 - 1
docs/ref/utils.txt

@@ -612,8 +612,10 @@ escaping HTML.
 .. function:: format_html(format_string, *args, **kwargs)
 
     This is similar to :meth:`str.format`, except that it is appropriate for
-    building up HTML fragments. All args and kwargs are passed through
+    building up HTML fragments. The first argument ``format_string`` is not
+    escaped but all other args and kwargs are passed through
     :func:`conditional_escape` before being passed to ``str.format()``.
+    Finally, the output has :func:`~django.utils.safestring.mark_safe` applied.
 
     For the case of building up small HTML fragments, this function is to be
     preferred over string interpolation using ``%`` or ``str.format()``