[Python-3000] What's the point of annotations?

Barry Warsaw barry at python.org
Tue Jan 2 19:15:17 CET 2007


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Jan 2, 2007, at 1:08 PM, Collin Winter wrote:

> The biggest problem I faced then and now is justifying the use-cases
> for annotations. Here's what I could come up with off the top of my
> head: information for typecheckers; doc strings for parameters; extra
> information for IDEs; extra information for static analysis tools like
> pylint. These can all be addressed together:

I've been using epydoc to document my public interfaces.  It seems  
like most of those use cases are (or easily could be) supported by  
epydoc docstrings.  Certainly for documenting parameters, epydoc is  
much more readable than the example you gave.  If you can get over  
parsing a docstring, it might already be enough.

- -Barry


-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (Darwin)

iQCVAwUBRZqhNnEjvBPtnXfVAQIISQQAgBXaHH7l+FqcZa9N0uaEuW8T8rN0A0c4
CoIYJJWu4s5Wb0h9j0J7e9opLHj/Pg9MZwNzJtEHIA2DnnNSiL34TxWkhWUxPuqC
C/9fRinBZ2HeFhwNo8p/Vol6kl31GzUgkMSvh7ovjml5dCfY9IgL7ynYFUGVD0UV
W6JaS/gXe08=
=AMVp
-----END PGP SIGNATURE-----


More information about the Python-3000 mailing list