[Python-checkins] r62850 - peps/trunk/pep-3108.txt

[brett.cannon]

Author: brett.cannon
Date: Thu May  8 06:40:25 2008
New Revision: 62850

Log:
Update the procedure for a module's removal to cover the 'deprecated' directive
in the module's docs. Also state that removing the module in 3.0 first is the
best option to know where the module itself is used.


Modified:
   peps/trunk/pep-3108.txt

Modified: peps/trunk/pep-3108.txt
==============================================================================
--- peps/trunk/pep-3108.txt	(original)
+++ peps/trunk/pep-3108.txt	Thu May  8 06:40:25 2008
@@ -871,9 +871,30 @@
 For modules to be removed
 -------------------------
 
-Use of modules which will not be deleted in the Python 2.x series
-will generate a ``DeprecationWarning`` using the
-``warnings.warn3k()`` function.
+For module removals, it is easiest to remove the module first in
+Python 3.0 to see where dependencies exist. This makes finding
+code that (possibly) requires the suppression of the
+DeprecationWarning easier.
+
+
+In Python 3.0
+/////////////
+
+#. Remove the module.
+
+#. Remove related tests.
+
+#. Remove all documentation.
+
+#. Edit ``Modules/Setup.dist`` and ``setup.py`` if needed.
+
+#. Run the regression test suite (using ``-uall``); watch out for
+   tests that are skipped because an import failed for the removed
+   module.
+
+#. Check in the change (with an appropriate ``Misc/NEWS`` entry).
+
+#. Update this PEP noting that the 3.0 step is done.
 
 
 In Python 2.6
@@ -891,7 +912,9 @@
    contains a command that will generate all of this for you).
 
 #. Update the documentation. For modules with their own documentation
-   file, use the ``:deprecated:`` option for the ``module`` directive.
+   file, use the ``:deprecated:`` option for the ``module`` directive
+   along with the ``deprecated`` directive, stating the deprecation
+   is occurring in 2.6, but is for the module's removal in 3.0.
    For modules simply listed in a file (e.g., ``undoc.rst``), use the
    ``warning`` directive.
 
@@ -903,27 +926,6 @@
 #. Update this PEP noting that the 2.6 step is done.
 
 
-
-In Python 3.0
-/////////////
-
-#. Remove the module.
-
-#. Remove related tests.
-
-#. Remove all documentation.
-
-#. Edit ``Modules/Setup.dist`` and ``setup.py`` if needed.
-
-#. Run the regression test suite (using ``-uall``); watch out for
-   tests that are skipped because an import failed for the removed
-   module.
-
-#. Check in the change (with an appropriate ``Misc/NEWS`` entry).
-
-#. Update this PEP noting that the 3.0 step is done.
-
-
 Renaming of modules
 -------------------