[ZCM] [ZC] 370/ 7 Comment "Remove validation of <dtml-comment> to improve documenting methods"

[Collector: Zope Bugs, Features, and Patches ...]

Issue #370 Update (Comment) "Remove validation of <dtml-comment> to improve documenting methods"
 Status Rejected, Zope/feature+solution medium
To followup, visit:
  http://collector.zope.org/Zope/370

==============================================================
= Comment - Entry #7 by to_be on Jan 2, 2003 8:06 am

I just tested the eval-tag product with Zope 2.6.0. It seems to work and not break anything, but the comment fix appears to work only when the dtml-comment is outside any other block tag (in a try-except block and in a dtml-in, the comment was validated in the  traditional way)
________________________________________
= Comment - Entry #6 by to_be on Jan 2, 2003 6:10 am

I'd suggest to merge Casey's changes to the comment tag (from the EvalTag product) into the source (unfortunately, I can't be more specific for now because of a currently non-working LAN).
________________________________________
= Comment - Entry #5 by Caseman on Dec 5, 2002 9:04 am

BTW: The Eval tag product I wrote in another life contains an enhancement to the DTML parser which allows tags to say "don't parse my contents as DTML". When you install this product (assuming it still works ;^), it also makes dtml-comment behave more as you would expect. Its contents are ignored instead of parsed.

http://www.zope.org/Members/Kaivo/EvalTag

-Casey
________________________________________
= Comment - Entry #4 by ajung on Dec 5, 2002 4:52 am

You are already using the collector for Zope 2.X.

To your problem:
feel free to submit a patch for this problem but it
is unlikely that someone of the Zope core developers
will work on this issue since the problem is
very well known and has a low priority. If you like to
see it fixed, please work on it.

-aj
________________________________________
= Comment - Entry #3 by to_be on Dec 5, 2002 4:43 am

>  Status: Pending => Rejected
> 
> This is a known, and understood, limitation with dtml-comment, > not a defect.

I disagree. It is not how comments are supposed to work. Fixing it wouldn't break any existing code.

> Contributors wishing to propose new code features are 
> encouraged to participate with the Zope 2.6 community
> contribution process.

Is there a collector for this? URL? I could find one for Zope 3, but not for 2.6 (which is out now). Putting people off to elsewhere without giving an URL is not very encouraging.

________________________________________
= Reject - Entry #2 by matt on Apr 29, 2002 1:55 pm

 Status: Pending => Rejected

This is a known, and understood, limitation with dtml-comment, not   a defect.

Contributors wishing to propose new code features are encouraged to  participate with the Zope 2.6 community contribution process.
________________________________________
= Request - Entry #1 by Anonymous User on Apr 29, 2002 1:49 pm

To my surprise, Zope tries to validate commented out code in the the <dtml-comment> block.  
Therefore, one *cannot* write an example as:
When called from <dtml-in Catalog>, this method renders...

Zope looks for a </dtml-in>, even though this is in the dtml-comment block.  This defeats the purpose of properly documenting DTML with DTML snippets to explain logic in methods, etc.

Zope does not execute anything in dtml-comment.
Therefore, it should not validate anything in dtml-comment.
==============================================================