[Python-ideas] Off topic: 'strike a balance' - second language English

Jonathan Fine jfine2358 at gmail.com
Tue Aug 21 12:55:34 EDT 2018


Nick Loadholtes wrote (elsewhere, quoted in this thread - by me).

> Make your docs work as hard as your code does. Clear examples will
> make your code stand out in a good way.

With a bit more searching I found:
<quote>
https://www.reddit.com/r/Python/comments/70myto/whats_new_in_python_37_python_370a0_documentation/dn4v667/

I'll disagree. Nothing is better than Mathworks documentation. I like
documentation by example.

Python gives you the dry, technically correct verbiage behind how
something works.

Matlab says: "Here, copy paste this and it'll work".

To the point that the workspace is designed to automatically strip >>>
from any copy and pasted commands.

Even with most Python examples you can't just copy and paste a chunk
of an example from the web or documentation because you need to clean
off >>> first.
</quote>

It did me good, to read the resulting discussion on reddit.

-- 
Jonathan


More information about the Python-ideas mailing list