Showing content from http://mail.python.org/pipermail/python-dev/attachments/20171106/aaccaee1/attachment.html below:
<br><br><div class="gmail_quote"><div dir="ltr">On Mon, Nov 6, 2017, 10:27 R. David Murray, <<a href="mailto:rdmurray@bitdance.com">rdmurray@bitdance.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">I agree with Steve. There is *cognitive* overhead to type annotations.<br>
I find that they make Python code harder to read and understand. So I<br>
object to them in the documentation and docstrings as well. (Note:<br>
while I agree that the notation is compact for the simple types, the<br>
fact that it would appear for some signatures and not for others is a<br>
show stopper from my point of view...consistency is important to reducing<br>
the cognitive overhead of reading the docs.)<br>
<br>
I'm dealing with the spread of annotations on my current project,<br>
having to ask programmers on the team to delete annotations that they've<br>
"helpfully" added that to my mind serve no purpose on a project of the<br>
size we're developing, where we aren't using static analysis for anything.<br></blockquote></div><div><br></div><div>I think this is the key point in your situation if the project is private.</div><div><br></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Maybe I'm being a curmudgeon standing in the way of progress, but I'm<br>
pretty sure there are a number of people in my camp :)<br></blockquote></div><div><br></div><div>The key thing here is there are people like me who are using your analyzers (and you are as well indirectly since the CLA bot is fully type hinted ð). I think the key question is whether we expect typeshed to keep up with richer annotations using typing or are basic ones in the stdlib going ot leave less of a gap in support in the long-term?</div><div><br></div><div>To be honest, I suspect most Python code in the stdlib would require protocols to be accurate (C code is another matter), but return type hints could be reasonably accurate.</div><div><br></div><div>-Brett</div><div><br></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
On Mon, 06 Nov 2017 16:22:23 +0000, Steve Holden <<a href="mailto:steve@holdenweb.com" target="_blank">steve@holdenweb.com</a>> wrote:<br>
> While I appreciate the value of annotations I think that *any* addition of<br>
> them to the stdlib would complicate an important learning resource<br>
> unnecessarily. S<br>
><br>
> Steve Holden<br>
><br>
> On Mon, Nov 6, 2017 at 4:07 PM, Victor Stinner <<a href="mailto:victor.stinner@gmail.com" target="_blank">victor.stinner@gmail.com</a>><br>
> wrote:<br>
><br>
> > Related to annotations, are you ok to annotate basic types in the<br>
> > *documentation* and/or *docstrings* of the standard library?<br>
> ><br>
> > For example, I chose to document the return type of time.time() (int)<br>
> > and time.time_ns() (float). It's short and I like how it's formatted.<br>
> > See the current rendered documentation:<br>
> ><br>
> > <a href="https://docs.python.org/dev/library/time.html#time.time" rel="noreferrer" target="_blank">https://docs.python.org/dev/library/time.html#time.time</a><br>
> ><br>
> > "Annotations" in the documentation and docstrings have no impact on<br>
> > Python runtime performance. Annotations in docstrings makes them a few<br>
> > characters longer and so impact the memory footprint, but I consider<br>
> > that the overhead is negligible, especially when using python3 -OO.<br>
_______________________________________________<br>
Python-Dev mailing list<br>
<a href="mailto:Python-Dev@python.org" target="_blank">Python-Dev@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/python-dev" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/python-dev</a><br>
Unsubscribe: <a href="https://mail.python.org/mailman/options/python-dev/brett%40python.org" rel="noreferrer" target="_blank">https://mail.python.org/mailman/options/python-dev/brett%40python.org</a><br>
</blockquote></div>
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4