Incorporate suggestions from Neal.

This commit is contained in:
Georg Brandl 2006-04-06 12:37:49 +00:00
parent 11afb96d86
commit dbd9039543
1 changed files with 13 additions and 3 deletions

View File

@ -49,6 +49,10 @@ the respective module and perhaps in the global document of Step 1.
Additionally, the python3warn.py script will recognize the old module
names and notify the user accordingly.
If the name change is made in time for another release of the Python 2.x
series, it is worth considering to introduce the new name in the 2.x
branch to ease transition.
Code cleanup
============
@ -58,19 +62,25 @@ for bug fixes, following the policy of never changing a running system,
many of them may contain code that is not up to the newest language
features and could be rewritten in a more concise, modern Python.
PyChecker should run cleanly over the library. With a carefully tuned
configuration file, PyLint should also emit as few warnings as possible.
As long as these changes don't change the module's interface and behavior,
no documentation updates are necessary.
Enhancement of test coverage
============================
Enhancement of test and documentation coverage
==============================================
Code coverage by unit tests varies greatly between modules. Each test
suite should be checked for completeness, and the remaining classic tests
should be converted to PyUnit (or whatever new shiny testing framework
comes with Python 3000, perhaps py.test?).
No documentation changes are necessary for this step.
It should also be verified that each publicly visible function has a
meaningful docstring which ideally contains several doctests.
No documentation changes are necessary for enhancing test coverage.
Unification of module metadata