#4382 closed (fixed)
specify in '{# ... #}' template doc section that this is only for single-line comments
Reported by: | Owned by: | Jacob | |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
I struggled for a little while to figure out why the use of '{# ... #}' stopped working when a line break was added to the "..." part. I'd just jumped to http://www.djangoproject.com/documentation/templates/#comments to see how to add a comment (not noticing the separate {%comment%} section lower down). It would be helpful to mention in that section that "{#...#}" is only for single-line comments. Perhaps something like:
This syntax only works for single-line comments. For multi-line comments use the {% comment %}...{% endcomment %} syntax <a href="http://www.djangoproject.com/documentation/templates/#comment">described below</a>.
Attachments (1)
Change History (5)
by , 18 years ago
comment:1 by , 18 years ago
Has patch: | set |
---|
Added a docs patch, some triager please checkit and mark ready-for-checkin? thanks! :)
comment:3 by , 18 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
I inadvertently fixed this whilst doing something else and only later remembered that I'd seen it in a ticket. Sorry, Marc, wasn't intending to ignore your patch. Fixed in [5359]
Add a note on docs/templates.txt stating that.