<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Mon, Jun 4, 2018 at 3:27 PM, Victor Stinner <span dir="ltr"><<a href="mailto:vstinner@redhat.com" target="_blank">vstinner@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">For Argument Clinic, have a look at<br>
<a href="https://docs.python.org/dev/howto/clinic.html" rel="noreferrer" target="_blank">https://docs.python.org/dev/<wbr>howto/clinic.html</a></blockquote><div><br></div><div>Thanks Victor -- scanning that page, it is indeed where I needed to look.</div><div><br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
You can also try to copy/paste code from other files using Argument<br>
Clinic and then run "make clinic" to regenerate the generated files.<br></blockquote><div><br></div><div>good idea.</div><div><br></div><div>Now to find some time to actually work on this...</div><div><br></div><div>-CHB</div><div><br></div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Victor<br>
<div><div class="h5"><br>
2018-06-04 23:45 GMT+02:00 Chris Barker via Python-Dev <<a href="mailto:python-dev@python.org">python-dev@python.org</a>>:<br>
> Over on python-ideas, someone is/was proposing literals for timedeltas.<br>
><br>
> I don't expect that will come to anything, but it did make me take a look at<br>
> the docstring for datetime.timedelta. I use iPython's ? a lot for a quick<br>
> overview of how to use a class/function.<br>
><br>
> This is what I get:<br>
><br>
> In [8]: timedelta?<br>
> Init signature: timedelta(self, /, *args, **kwargs)<br>
> Docstring:      Difference between two datetime values.<br>
> File:           ~/miniconda2/envs/py3/lib/<wbr>python3.6/datetime.py<br>
> Type:           type<br>
><br>
><br>
> That is, well, not so useful. I'd like to see at least the signature:<br>
><br>
> datetime.timedelta(days=0, seconds=0, microseconds=0, milliseconds=0,<br>
> minutes=0, hours=0, weeks=0<br>
><br>
> And ideally much of the text in the docs.<br>
><br>
> I've noticed similarly minimal docstrings on a number of builtin functions<br>
> and methods.<br>
><br>
> If I wanted to contribute a PR to enhance these docstrings, where would they<br>
> go?  I've seen mention of "argument clinic", but really don't know quite<br>
> what that is, or how it works, but it appears to be related.<br>
><br>
> Anyway -- more comprehensive docstrings on buildins could really help<br>
> Python's usability for command line usage.<br>
><br>
> Thanks,<br>
> -  Chris<br>
><br>
><br>
><br>
><br>
> --<br>
><br>
> Christopher Barker, Ph.D.<br>
> Oceanographer<br>
><br>
> Emergency Response Division<br>
> NOAA/NOS/OR&R            (206) 526-6959   voice<br>
> 7600 Sand Point Way NE   (206) 526-6329   fax<br>
> Seattle, WA  98115       (206) 526-6317   main reception<br>
><br>
> <a href="mailto:Chris.Barker@noaa.gov">Chris.Barker@noaa.gov</a><br>
><br>
</div></div>> ______________________________<wbr>_________________<br>
> Python-Dev mailing list<br>
> <a href="mailto:Python-Dev@python.org">Python-Dev@python.org</a><br>
> <a href="https://mail.python.org/mailman/listinfo/python-dev" rel="noreferrer" target="_blank">https://mail.python.org/<wbr>mailman/listinfo/python-dev</a><br>
> Unsubscribe:<br>
> <a href="https://mail.python.org/mailman/options/python-dev/vstinner%40redhat.com" rel="noreferrer" target="_blank">https://mail.python.org/<wbr>mailman/options/python-dev/<wbr>vstinner%40redhat.com</a><br>
><br>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><br>Christopher Barker, Ph.D.<br>Oceanographer<br><br>Emergency Response Division<br>NOAA/NOS/OR&R            (206) 526-6959   voice<br>7600 Sand Point Way NE   (206) 526-6329   fax<br>Seattle, WA  98115       (206) 526-6317   main reception<br><br><a href="mailto:Chris.Barker@noaa.gov" target="_blank">Chris.Barker@noaa.gov</a></div>
</div></div>