Commit cb3266c1 authored by Bryce Nesbitt's avatar Bryce Nesbitt Committed by Tim Graham
Browse files

[1.7.x] Fixed #22753 -- Documented ability to use a note with the {% comment %} tag.

Backport of e0208944 from master
parent 170255ca
Loading
Loading
Loading
Loading
+3 −1
Original line number Diff line number Diff line
@@ -52,11 +52,13 @@ comment
^^^^^^^

Ignores everything between ``{% comment %}`` and ``{% endcomment %}``.
An optional note may be inserted in the first tag. For example, this is
useful when commenting out code for documenting why the code was disabled.

Sample usage::

    <p>Rendered text with {{ pub_date|date:"c" }}</p>
    {% comment %}
    {% comment "Optional note" %}
        <p>Commented out text with {{ create_date|date:"c" }}</p>
    {% endcomment %}