[prev in list] [next in list] [prev in thread] [next in thread]
List: python-dev
Subject: [Python-Dev] Re: Enhancing generic type documentation in the standard library
From: Guido van Rossum <guido () python ! org>
Date: 2022-03-30 20:15:25
Message-ID: CAP7+vJKTSJ1v0t-CtoA3zwXFbASnf537A94DeJCEXcHbvvddMA () mail ! gmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
On Wed, Mar 30, 2022 at 12:42 PM Steve Holden <steve@holdenweb.com> wrote:
> Not defining the semantics of annotations was a brave move, but
> inevitably led to the situation where different use cases, all
> quite reasonable, would spring into being. Now they have, the development
> team has to decide a) which ones to sanction and b) which will be left out
> in the cold.
>
Interesting, in the JavaScript (excuse me, ECMAScript) world, there's
currently a proposal on the table to do just that, on steroids:
https://github.com/giltayar/proposal-types-as-comments (full disclosure:
some of the proposal authors are colleagues of mine). We'll have to see how
they fare.
> I wish them well.
>
> Kind regards,
> Steve
>
>
> On Wed, Mar 30, 2022 at 5:24 PM Christopher Barker <pythonchb@gmail.com>
> wrote:
>
>> > I personally would love for a typing.python.org or equivalent
>> subsection of docs.python.org to exist.
>>
>> +1
>>
>> There's a wrinkle here, however. The type specs are Python, but how they
>> are used/interpreted is up to third party packages.
>>
>> So it's a bit tricky to know exactly what to document where.
>>
>> I don't think that's insurmountable, but something to keep in mind.
>>
>> For example, while the clear specs are the first step, what the community
>> really could use is a good "recommended practices for static typing" doc —
>> and that's harder to do without reference to particular tools.
>>
>> -CHB
>>
>>
>> --
>> Christopher Barker, PhD (Chris)
>>
>> Python Language Consulting
>> - Teaching
>> - Scientific Software Development
>> - Desktop GUI and Web Development
>> - wxPython, numpy, scipy, Cython
>> _______________________________________________
>> Python-Dev mailing list -- python-dev@python.org
>> To unsubscribe send an email to python-dev-leave@python.org
>> https://mail.python.org/mailman3/lists/python-dev.python.org/
>> Message archived at
>> https://mail.python.org/archives/list/python-dev@python.org/message/YF5UIQIWNVIANFOCIQ2J4DJACQGJDGVM/
>> Code of Conduct: http://python.org/psf/codeofconduct/
>>
> _______________________________________________
> Python-Dev mailing list -- python-dev@python.org
> To unsubscribe send an email to python-dev-leave@python.org
> https://mail.python.org/mailman3/lists/python-dev.python.org/
> Message archived at
> https://mail.python.org/archives/list/python-dev@python.org/message/NW3SRUA2H3KNZBD4CICXY5QF2YWELUV5/
> Code of Conduct: http://python.org/psf/codeofconduct/
>
--
--Guido van Rossum (python.org/~guido)
*Pronouns: he/him **(why is my pronoun here?)*
<http://feministing.com/2015/02/03/how-using-they-as-a-singular-pronoun-can-change-the-world/>
[Attachment #5 (text/html)]
<div dir="ltr"><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Mar \
30, 2022 at 12:42 PM Steve Holden <<a \
href="mailto:steve@holdenweb.com">steve@holdenweb.com</a>> \
wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px \
0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div \
style="font-size:small">Not defining the semantics of annotations was a brave move, \
but inevitably led to the situation where different use cases, all quite \
reasonable, would spring into being. Now they have, the development team has to \
decide a) which ones to sanction and b) which will be left out in the \
cold.</div></div></blockquote><div><br></div><div>Interesting, in the JavaScript \
(excuse me, ECMAScript) world, there's currently a proposal on the table to do \
just that, on steroids: <a \
href="https://github.com/giltayar/proposal-types-as-comments">https://github.com/giltayar/proposal-types-as-comments</a> \
(full disclosure: some of the proposal authors are colleagues of mine). We'll \
have to see how they fare.<br></div><div> </div><blockquote class="gmail_quote" \
style="margin:0px 0px 0px 0.8ex;border-left:1px solid \
rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div style="font-size:small">I wish \
them well.</div><div style="font-size:small"><br></div><div><div dir="ltr"><div \
dir="ltr"><div><div dir="ltr">Kind regards,</div><div \
dir="ltr">Steve<br></div></div></div></div></div><br></div><br><div \
class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Mar 30, 2022 at 5:24 PM \
Christopher Barker <<a href="mailto:pythonchb@gmail.com" \
target="_blank">pythonchb@gmail.com</a>> wrote:<br></div><blockquote \
class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid \
rgb(204,204,204);padding-left:1ex"><div dir="auto">> I personally would love for a \
<a href="http://typing.python.org" rel="noreferrer" \
target="_blank">typing.python.org</a> or equivalent subsection of <a \
href="http://docs.python.org" rel="noreferrer" target="_blank">docs.python.org</a> to \
exist.</div><div dir="auto"><br></div><div dir="auto">+1</div><div \
dir="auto"><br></div><div dir="auto">There's a wrinkle here, however. The type specs \
are Python, but how they are used/interpreted is up to third party \
packages.</div><div dir="auto"><br></div><div dir="auto">So it's a bit tricky to know \
exactly what to document where.</div><div dir="auto"><br></div><div dir="auto">I \
don't think that's insurmountable, but something to keep in mind.</div><div \
dir="auto"><br></div><div dir="auto">For example, while the clear specs are the first \
step, what the community really could use is a good "recommended practices for static \
typing" doc — and that's harder to do without reference to particular tools. \
</div><div dir="auto"><br></div><div dir="auto">-CHB </div><div \
dir="auto"><br></div><div dir="auto"><br></div>-- <br><div dir="ltr"><div \
dir="ltr">Christopher Barker, PhD (Chris)<br><br> Python Language Consulting<br> - \
Teaching<br> - Scientific Software Development<br> - Desktop GUI and Web \
Development<br> - wxPython, numpy, scipy, Cython<br></div></div> \
_______________________________________________<br> Python-Dev mailing list -- <a \
href="mailto:python-dev@python.org" target="_blank">python-dev@python.org</a><br> To \
unsubscribe send an email to <a href="mailto:python-dev-leave@python.org" \
target="_blank">python-dev-leave@python.org</a><br> <a \
href="https://mail.python.org/mailman3/lists/python-dev.python.org/" rel="noreferrer" \
target="_blank">https://mail.python.org/mailman3/lists/python-dev.python.org/</a><br> \
Message archived at <a \
href="https://mail.python.org/archives/list/python-dev@python.org/message/YF5UIQIWNVIANFOCIQ2J4DJACQGJDGVM/" \
rel="noreferrer" target="_blank">https://mail.python.org/archives/list/python-dev@python.org/message/YF5UIQIWNVIANFOCIQ2J4DJACQGJDGVM/</a><br>
Code of Conduct: <a href="http://python.org/psf/codeofconduct/" rel="noreferrer" \
target="_blank">http://python.org/psf/codeofconduct/</a><br> </blockquote></div>
_______________________________________________<br>
Python-Dev mailing list -- <a href="mailto:python-dev@python.org" \
target="_blank">python-dev@python.org</a><br> To unsubscribe send an email to <a \
href="mailto:python-dev-leave@python.org" \
target="_blank">python-dev-leave@python.org</a><br> <a \
href="https://mail.python.org/mailman3/lists/python-dev.python.org/" rel="noreferrer" \
target="_blank">https://mail.python.org/mailman3/lists/python-dev.python.org/</a><br> \
Message archived at <a \
href="https://mail.python.org/archives/list/python-dev@python.org/message/NW3SRUA2H3KNZBD4CICXY5QF2YWELUV5/" \
rel="noreferrer" target="_blank">https://mail.python.org/archives/list/python-dev@python.org/message/NW3SRUA2H3KNZBD4CICXY5QF2YWELUV5/</a><br>
Code of Conduct: <a href="http://python.org/psf/codeofconduct/" rel="noreferrer" \
target="_blank">http://python.org/psf/codeofconduct/</a><br> </blockquote></div><br \
clear="all"><br>-- <br><div dir="ltr" class="gmail_signature"><div \
dir="ltr"><div><div dir="ltr"><div>--Guido van Rossum (<a \
href="http://python.org/~guido" target="_blank">python.org/~guido</a>)</div><div><i \
style="font-family:Arial,Helvetica,sans-serif;font-size:small;font-weight:400;letter-s \
pacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal; \
word-spacing:0px;background-color:rgb(255,255,255);color:rgb(136,136,136)"><span>Pronouns</span>: \
he/him </i><a href="http://feministing.com/2015/02/03/how-using-they-as-a-singular-pronoun-can-change-the-world/" \
style="color:rgb(17,85,204);font-family:Arial,Helvetica,sans-serif;font-size:small;fon \
t-style:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px; \
text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255)" \
target="_blank"><i>(why is my <span>pronoun</span> \
here?)</i></a></div></div></div></div></div></div>
_______________________________________________
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-leave@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at https://mail.python.org/archives/list/python-dev@python.org/message/YUGMANOPKSAR7SPDLQGTDGFAID6H5YHA/
Code of Conduct: http://python.org/psf/codeofconduct/
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic