[Python-Dev] Convention on functions that shadow existing stdlib functions

Nick Coghlan ncoghlan at gmail.com
Thu Jul 28 01:05:11 CEST 2011


On Thu, Jul 28, 2011 at 3:27 AM, Brett Cannon <brett at python.org> wrote:
> On Wed, Jul 27, 2011 at 06:36, R. David Murray <rdmurray at bitdance.com>
> wrote:
>> Perhaps what we could do is move the documentation for test.support to
>> the devguide, and then vet the test suite so that unlink and friends
>> are always called as 'support.unlink', etc.
>
> I like this solution since this issue of documenting test.support keeps
> coming up. Otherwise we can not document test.support, but  then we need to
> do a pass through the module to make sure  that the docstrings are properly
> updated and we start deprecating some of the stuff in there that is just
> pure cruft.

+1 for relocating this to the devguide. The only reason this is in the
main docs now is that it used to be the only way to easily get pretty
documentation for it.

Cheers,
Nick.

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


More information about the Python-Dev mailing list