This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author rhettinger
Recipients chris.jerdonek, eric.araujo, ezio.melotti, nitika, rhettinger, terry.reedy
Date 2014-04-05.21:56:48
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1396735009.45.0.132373413407.issue16927@psf.upfronthosting.co.za>
In-reply-to
Content
> This include two main groups that should be separated in 
> two different sections:  built-in types and functions.

I forgot to mention that the docs have already been organized to cover the two groups.  Section 3.2 has the built-in functions and Section 3.4 has the built-in types.  Where they overlap (str and list, for example), section section addresses their use as a function (i.e. list(iterable) acts like a function that loops over an iterable to create a list, and str(x) like a function to lookup the string representation of an object).

The current organization has been somewhat successful and I don't want to damage it by regrouping.  

> This will make it easier to find similar functions,

This isn't the primary role of a library reference.  That said, I would not object to either 1) an extra section that shows a high level grouping of functions or 2) adding to each function a list of see also links (the Microsoft Excel documentation takes that approach).

> and will allow us to factor out some documentation that is repeated[0].

This should not be done either.  For example, we really to want min() and max() to be completely documented in isolation from one another (this is a reference document, repeating definitions as dictionaries do is proper).
History
Date User Action Args
2014-04-05 21:56:49rhettingersetrecipients: + rhettinger, terry.reedy, ezio.melotti, eric.araujo, chris.jerdonek, nitika
2014-04-05 21:56:49rhettingersetmessageid: <1396735009.45.0.132373413407.issue16927@psf.upfronthosting.co.za>
2014-04-05 21:56:49rhettingerlinkissue16927 messages
2014-04-05 21:56:48rhettingercreate