[issue19723] Argument Clinic should add markers for humans

[Nick Coghlan]

Nick Coghlan added the comment:

On 23 Nov 2013 08:05, "Larry Hastings" <report at bugs.python.org> wrote:
>
>
> Larry Hastings added the comment:
>
> > However, to bikeshed a little, I would prefer
> > "preprocessor" instead of "clinic", since jokes
> > tend to wear off if one sees then too often.
>
> "Argument Clinic" is the name of the tool.  The marker /*[clinic]*/
> was chosen deliberately:
>
> * If someone says "what the hell is this" a quick online search
>   should turn up the answer quickly.
>
> * It differentiates it from /*[python]*/, which allows one to embed
>   raw Python code inside files.  ("print" is redirected to the output
>   section.)

It also differentiates it clearly from the C preprocessor. If Guido can
name the language after a comedy troupe, Larry can certainly name the
custom code generator after one of their sketches :)

FWIW, I tend to start editing the generated code as well, so I agree this
is something for us to keep an eye on. If the habit doesn't go away, we may
want some more prominent markers.

Cheers,
Nick.

>
> ----------
>
> _______________________________________
> Python tracker <report at bugs.python.org>
> <http://bugs.python.org/issue19723>
> _______________________________________

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19723>
_______________________________________