[Python-ideas] Linking Doug's stdlib documentation to our main modules doc.

Jesse Noller jnoller at gmail.com
Sun Mar 20 23:19:42 CET 2011

On Sun, Mar 20, 2011 at 5:11 PM, Nick Coghlan <ncoghlan at gmail.com> wrote:
> On Mon, Mar 21, 2011 at 4:18 AM, Alexander Belopolsky
> <alexander.belopolsky at gmail.com> wrote:
>> The reference manual and PyMOTW are two different works
>> targeting different audiences.  PyMOTW is more like a tutorial, trying
>> to concisely introduce main features of each module without a claim to
>> be comprehensive.   In the reference manual on the other hand we try
>> to be complete in feature coverage and economical in illustrative
>> examples.
> You just summarised *exactly* why a bunch of us want to include it in
> the official documentation (by reference, anyway): so people can read
> PyMOTW as an introduction, and use the official docs as a reference.
> A See Also at the bottom of individual module pages, plus an "External
> Resources" link on the front page of the docs (as you suggested) would
> cover that nicely (especially with a pydotorg redirector in place to
> guarantee link stability).
> Cheers,
> Nick.

What Nick said. You summarized why we want this done in the first
place - the narrative/tutorial style works really, really well for a
lot of people, non programmers and beginners. They're not API docs,
and they're not meant to be.

For the record? When I'm dealing with datetime, or logging, or other
"bigger" modules - I tend to go to doug's site first to see if I can
find a quick bit before I go through the official docs.


More information about the Python-ideas mailing list