[Python-3000] Draft pre-PEP: function annotations

Talin talin at acm.org
Sat Aug 12 23:07:18 CEST 2006

Paul Prescod wrote:
> Phillip. I'm having trouble following the discussion. I briefly caught up
> when Talin got very concrete with syntax and I would appreciate if you 
> could
> offer some correspondingly remedial training.
> Talin's example is that metadata inventor A documents that his/her users
> should use this syntax for parameter docstrings:
> def myfunc( x : "The x coordinate", y : "The y coordinate" )
>      ...

One important point I want to mention. I deliberately did *not* show a 
decorator for this above example. The reason for this is that the 
docstring annotations are not intended for consumption by a decorator 
function - they are intended for consumption by an external program that 
extracts documentation.

More specifically, this external doc extractor program would be part of 
a standard package of documentation tools, written by an entirely 
different author than the person actually writing 'myfunc'. This doc 
extractor knows nothing about decorators, and is unconcerned with their 

So I'd like Phillip to incorporate that into his explanation of how that 
is all supposed to work.

-- Talin

More information about the Python-3000 mailing list