diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/templates/builtins.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index ca44da3bda..d904d06df4 100644 --- a/docs/ref/templates/builtins.txt +++ b/docs/ref/templates/builtins.txt @@ -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 %} |