[Python-checkins] r70438 - python/trunk/Doc/library/functions.rst

Nick Coghlan ncoghlan at gmail.com
Tue Mar 17 22:04:19 CET 2009


Raymond Hettinger wrote:
> FWIW, I think the examples need to be *very* short.
> The functions.rst page is growing hard to read because
> of all of the lengthy examples, caveats, warnings, and
> saying verbosity.  We don't want to turn the main docs
> into a tutorial.  It makes them harder to use.   If someone
> just wants to scan what the builtin functions do, they now
> face a very lengthy page of reading.  It's getting too fat.
> 
> I think the example below is way too long.

Perhaps the page just needs an overview section or table at the start
that just gives a one line description of each method, and then links to
the more detailed descriptions with longer examples?

Cheers,
Nick.

-- 
Nick Coghlan   |   ncoghlan at gmail.com   |   Brisbane, Australia
---------------------------------------------------------------


More information about the Python-checkins mailing list