[Python-Dev] Convention on functions that shadow existing stdlib functions
Antoine Pitrou
solipsis at pitrou.net
Sat Jul 30 15:38:00 CEST 2011
On Sat, 30 Jul 2011 09:25:27 -0400
Terry Reedy <tjreedy at udel.edu> wrote:
> >
> > I'm sorry, can you be more precise. The effect of what?
>
> Your proposal to remove the current formatted documentation of
> test.support instead of completing it and force all developers to only
> have reference to the docstrings scattered through the code.
>
> > And why would that be so?
>
> Because not everyone is like you. Because the condensed formatted docs
> make learning and using a module significantly easier for some people.
Ok, I understand. I just hope the notice at the top of the module doc
is prominent enough that nobody will think there's any API guarantee
there.
Regards
Antoine.
More information about the Python-Dev
mailing list