<div dir="ltr">"Napoleon"?<br></div><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Jan 19, 2015 at 12:48 PM, Georg Brandl <span dir="ltr"><<a href="mailto:g.brandl@gmx.net" target="_blank">g.brandl@gmx.net</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On 01/19/2015 08:54 PM, Guido van Rossum wrote:<br>
> Unfortunately PEP 257 falls short on specifying how to describe arguments -- it<br>
> has only one example, it's not normative, and there's not much code that follows<br>
> the example. The reST conventions are more common, but the stdlib itself rarely<br>
> uses them. It would be nice to come up with a better convention that takes PEP<br>
> 484 into account (so doc generators can incorporate the argument type<br>
> annotations into the generated output, merged with per-argument from the docstring).<br>
<br>
I'll be happy to implement that.  Basically if you use<br>
<br>
:param x: description<br>
:type x: type<br>
<br>
you could just leave out the "type" line and have it generated from the annotation.<br>
<br>
I guess it's very similar for Google and numpy style docstrings, which are<br>
supported by the (as of 1.3 built-in) Napoleon extension.<br>
<br>
Georg<br>
<br>
_______________________________________________<br>
Python-ideas mailing list<br>
<a href="mailto:Python-ideas@python.org">Python-ideas@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/python-ideas" target="_blank">https://mail.python.org/mailman/listinfo/python-ideas</a><br>
Code of Conduct: <a href="http://python.org/psf/codeofconduct/" target="_blank">http://python.org/psf/codeofconduct/</a><br>
</blockquote></div><br><br clear="all"><br>-- <br><div class="gmail_signature">--Guido van Rossum (<a href="http://python.org/~guido">python.org/~guido</a>)</div>
</div>