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

[Raymond Hettinger]

[Benjamin Peterson]
> Telling precisely what a function does is important, but to take a
> cliche, "a code example tells a thousand words." Functions aren't used
> alone in programs; they're in context. Examples provide higher level
> guidance about how a function is usually used.

Just show some judgment and restraint.

Using the above philosophy, we could easily double or treble the
size of the docs and in the process hurt their usability.

Also, make some effort to find the smallest possible code fragment
that communicates what the function does.


Raymond