]> granicus.if.org Git - python/commitdiff
Fix-up docs for the copyreg module renaming.
authorGeorg Brandl <georg@python.org>
Mon, 12 May 2008 10:05:39 +0000 (10:05 +0000)
committerGeorg Brandl <georg@python.org>
Mon, 12 May 2008 10:05:39 +0000 (10:05 +0000)
Doc/library/copy.rst
Doc/library/copyreg.rst [moved from Doc/library/copy_reg.rst with 76% similarity]
Doc/library/persistence.rst
Doc/library/pickle.rst

index 89b668d5f9f09ecd9fe10d49517d89f246a6e748..ce127a363350def33de223ee8b4754fe76181653 100644 (file)
@@ -63,7 +63,7 @@ of lists by assigning a slice of the entire list, for example,
 
 Classes can use the same interfaces to control copying that they use to control
 pickling.  See the description of module :mod:`pickle` for information on these
-methods.  The :mod:`copy` module does not use the :mod:`copy_reg` registration
+methods.  The :mod:`copy` module does not use the :mod:`copyreg` registration
 module.
 
 .. index::
similarity index 76%
rename from Doc/library/copy_reg.rst
rename to Doc/library/copyreg.rst
index 407044c4bb288cb4112d1fe93f28faeb19d7ff76..3a3f815de85dc1bdf0e74137a7dae6988c1fc6ff 100644 (file)
@@ -1,19 +1,23 @@
-
-:mod:`copy_reg` --- Register :mod:`pickle` support functions
-============================================================
+:mod:`copyreg` --- Register :mod:`pickle` support functions
+===========================================================
 
 .. module:: copy_reg
+   :synopsis: Old name for the copyreg module.
+
+.. module:: copyreg
    :synopsis: Register pickle support functions.
 
 .. note::
-    The :mod:`copy_reg` module has been renamed to `copyreg` in Python 3.0.
+   The :mod:`copy_reg` module has been renamed to :mod:`copyreg` in Python 3.0.
+   It is importable under both names in Python 2.6 and the rest of the 2.x
+   series.
 
 .. index::
    module: pickle
    module: cPickle
    module: copy
 
-The :mod:`copy_reg` module provides support for the :mod:`pickle` and
+The :mod:`copyreg` module provides support for the :mod:`pickle` and
 :mod:`cPickle` modules.  The :mod:`copy` module is likely to use this in the
 future as well.  It provides configuration information about object constructors
 which are not classes.  Such constructors may be factory functions or class
index 78e40f64460421187fdf64d65ef8643cba5a1f93..3708d17fb8e6866a1943782dd07c2a3d438b3692 100644 (file)
@@ -19,7 +19,7 @@ The list of modules described in this chapter is:
 .. toctree::
 
    pickle.rst
-   copy_reg.rst
+   copyreg.rst
    shelve.rst
    marshal.rst
    anydbm.rst
index f19726159fe2e8806563f5a0876aa9039cc8ceb6..eefa4d33b8304b835e59dc80208effedc1f85c2d 100644 (file)
@@ -535,7 +535,7 @@ not :meth:`__reduce_ex__`, the :meth:`__reduce_ex__` implementation detects this
 and calls :meth:`__reduce__`.
 
 An alternative to implementing a :meth:`__reduce__` method on the object to be
-pickled, is to register the callable with the :mod:`copy_reg` module.  This
+pickled, is to register the callable with the :mod:`copyreg` module.  This
 module provides a way for programs to register "reduction functions" and
 constructors for user-defined types.   Reduction functions have the same
 semantics and interface as the :meth:`__reduce__` method described above, except
@@ -786,7 +786,7 @@ the same process or a new process. ::
 
 .. seealso::
 
-   Module :mod:`copy_reg`
+   Module :mod:`copyreg`
       Pickle interface constructor registration for extension types.
 
    Module :mod:`shelve`