PEP 350: Codetags

[Terry Hancock]

On Monday 26 September 2005 10:25 pm, Paul Rubin wrote:
> > I really doubt you'll find much agreement for this (the compiler
> > should enforce it) position.  The 'fewer conventions are better'
> > position might enjoy more support, but doesn't strike me as
> > particularly Pythonic (e.g. compare whitespace in Python and C).
> 
> It's ok if the enforcement isn't strict.

In this case, of course, it wouldn't be the compiler, but rather
automatic documentation tools that enforce the convention (i.e.
they will choke and/or not generate correct documentation if the
convention is not followed.  The PEP specifically mentions a
validating application (check that codetags are correct).

Nevertheless, enforcement does occur. This is the same situation
as with docstring conventions (fields in epydoc for example, or
using restructured text).  By having a PEP convention for this
sort of thing, it becomes easier for such applications to be
written.

Doesn't that qualify as "non-strict enforcement"?


--
Terry Hancock ( hancock at anansispaceworks.com )
Anansi Spaceworks  http://www.anansispaceworks.com