On Wed, Jul 7, 2010 at 2:12 PM, Barry Warsaw <ba...@python.org> wrote: .. > Does it make sense to add (reST-style) epydoc markup for API signatures? > E.g. > > def create_foo(name, parent=None): > """Create the named foo. > > The named foo must not already exist, but if optional `parent` is given, > it must exist. > > :param name: The name of the new foo. > :type name: string ..
-1. Repeating the function signature in the docstring only adds clutter and Java-style formal types/exceptions specifications are rarely appropriate in Python. I think marking arguments up with * as in *name*, *parent*, should be enough in most cases. _______________________________________________ Python-Dev mailing list Python-Dev@python.org http://mail.python.org/mailman/listinfo/python-dev Unsubscribe: http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
