diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt index 6d6c159fe3c..c632ad38c17 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::
Rendered text with {{ pub_date|date:"c" }}
- {% comment %} + {% comment "Optional note" %}Commented out text with {{ create_date|date:"c" }}
{% endcomment %}