Ticket #16939: r17141-howto-custom-template-tags-comment.diff

docs/howto/custom-template-tags.txt

@@ -1155 +1155 @@
 To create a template tag such as this, use ``parser.parse()`` in your
 compilation function.
 
-Here's how the standard :ttag:`{% comment %}<comment>` tag is implemented:
+Here's how a simplified ``{% comment %}`` tag might be implemented:
 
 .. code-block:: python
 
@@ -1168 +1168 @@
         def render(self, context):
             return ''
 
+.. note::
+    The actual implementation of :ttag:`{% comment %}<comment>` is slightly
+    different in that it allows broken template tags to appear between
+    ``{% comment %}`` and ``{% endcomment %}``. It does so by calling
+    ``parser.skip_past('endcomment')`` instead of ``parser.parse(('endcomment',))``
+    followed by ``parser.delete_first_token()``, thus avoiding the generation of a
+    node list.
+
 ``parser.parse()`` takes a tuple of names of block tags ''to parse until''. It
 returns an instance of ``django.template.NodeList``, which is a list of
 all ``Node`` objects that the parser encountered ''before'' it encountered

docs/ref/templates/builtins.txt

@@ -51 +51 @@
 comment
 ^^^^^^^
 
-Ignores everything between ``{% comment %}`` and ``{% endcomment %}``
+Ignores everything between ``{% comment %}`` and ``{% endcomment %}``.
 
 .. templatetag:: csrf_token