[Python-ideas] Executor Docs [was: Re: Add an introspection API to Executor]

[Nick Coghlan]

On 26 Aug 2014 16:12, "Ethan Furman" <ethan at stoneleaf.us> wrote:
> Looking at the docs again, I think the biggest hurdle to finding that
line and recognizing it for what it is is the fact that it comes /after/
all the examples.  That's backwards.  Why would you need examples for
something you haven't read yet?

Many of our module docs serve a dual purpose as a tutorial *and* as an API
reference. That's actually a problem, and often a sign of a separate
"HOWTO" guide trying to get out.

Actually doing the work to split them is rather tedious though, so it tends
not to happen very often.

Cheers,
Nick.

>
> --
> ~Ethan~
>
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> https://mail.python.org/mailman/listinfo/python-ideas
> Code of Conduct: http://python.org/psf/codeofconduct/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20140826/f89e4bac/attachment.html>