Opened 12 years ago

Closed 12 years ago

Last modified 12 years ago

#4382 closed (fixed)

specify in '{# ... #}' template doc section that this is only for single-line comments

Reported by: Trent Mick <trentm@…> Owned by: Jacob
Component: Documentation Version: master
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


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 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="">described below</a>.

Attachments (1)

4382.diff (417 bytes) - added by Marc Fargas <telenieko@…> 12 years ago.
Add a note on docs/templates.txt stating that.

Download all attachments as: .zip

Change History (5)

Changed 12 years ago by Marc Fargas <telenieko@…>

Attachment: 4382.diff added

Add a note on docs/templates.txt stating that.

comment:1 Changed 12 years ago by Marc Fargas <telenieko@…>

Has patch: set

Added a docs patch, some triager please checkit and mark ready-for-checkin? thanks! :)

comment:2 Changed 12 years ago by Simon G. <dev@…>

Triage Stage: UnreviewedReady for checkin

done and dusted.

comment:3 Changed 12 years ago by Malcolm Tredinnick

Resolution: fixed
Status: newclosed

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]

comment:4 Changed 12 years ago by Marc Fargas <telenieko@…>

Don't worry ;)

Note: See TracTickets for help on using tickets.
Back to Top