On Sun, Aug 28, 2011 at 2:28 PM, Guido van Rossum <[email protected]> wrote: > On Sat, Aug 27, 2011 at 8:59 PM, Ezio Melotti <[email protected]> wrote: >> I think it would be good to: >> 1) have some document that explains the general design and main (internal) >> functions of the module (e.g. a PEP); > > I don't think that such a document needs to be a PEP; PEPs are usually > intended where there is significant discussion expected, not just to > explain things. A README file or a Wiki page would be fine, as long as > it's sufficiently comprehensive.
timsort.txt and dictnotes.txt may be useful precedents for the kind of thing that is useful on that front. IIRC, the pymalloc stuff has a massive embedded comment, which can also work. Cheers, Nick. -- Nick Coghlan | [email protected] | Brisbane, Australia _______________________________________________ Python-Dev mailing list [email protected] http://mail.python.org/mailman/listinfo/python-dev Unsubscribe: http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
