RetroSearch Browse

Wed Jul 27 19:47:13 CEST 2011 · https://mail.python.org/pipermail/python-dev/2011-July/112574.html

On 7/27/2011 1:27 PM, Brett Cannon 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,

We already do.

25.6. test.support — Utility functions for tests
is about half of the page that also contains
25.5. test — Regression tests package for Python
The latter contains
25.5.1. Writing Unit Tests for the test package
which should also be moved to the dev guide if 25.6 is.

That would leave 25.5 as a short page explaining what lib/test is and 
how to run the tests, which is something user sometimes need to do.

> 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.

I believe that is what Eli is doing and hence the suggestion to dump 
.rmtree. Agreed that missing doc strings should be 'updated' from ''.

-- 
Terry Jan Reedy

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://mail.python.org/pipermail/python-dev/2011-July/112574.html below:

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