<p dir="ltr"><br>
On Jan 20, 2015 5:32 PM, "Guido van Rossum" <<a href="mailto:guido@python.org">guido@python.org</a>> wrote:<br>
><br>
> On Mon, Jan 19, 2015 at 10:39 PM, Terry Reedy <<a href="mailto:tjreedy@udel.edu">tjreedy@udel.edu</a>> wrote:<br>
>><br>
>> On 1/19/2015 2:54 PM, Guido van Rossum wrote:<br>
>>><br>
>>> Unfortunately PEP 257 falls short on specifying how to describe<br>
>>> arguments -- it has only one example, it's not normative, and there's<br>
>>> not much code that follows the example. The reST conventions are more<br>
>>> common, but the stdlib itself rarely uses them.<br>
>><br>
>><br>
>> Because I have not seen such used, except maybe once, I have been meaning to ask if I am allowed to use rst markup in stdlib docstrings?<br>
><br>
><br>
> I prefer you don't use them. We don't generate docs from the stdlib sources, and if someone generated them locally they would probably be doing themselves a disservice -- the docstrings exist for the benefit of the help() builtin, which AFAIK doesn't understand rst markup.<br>
>  </p>
<p dir="ltr">Might the lack of rst support in help() be something to address either as part of this effort or in parallel with it?</p>