From: Georg Brandl <georg@python.org>
Date: Wed, 9 Sep 2009 16:49:13 +0000 (+0000)
Subject: Properly document copy and deepcopy as functions.
X-Git-Tag: v2.7a1~561
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ffdde9e959513e72a7ac649e9c2fc70566778453;p=thirdparty%2FPython%2Fcpython.git

Properly document copy and deepcopy as functions.
---

diff --git a/Doc/library/copy.rst b/Doc/library/copy.rst
index 89b668d5f9f0..b3ce51f57e40 100644
--- a/Doc/library/copy.rst
+++ b/Doc/library/copy.rst
@@ -1,25 +1,28 @@
-
 :mod:`copy` --- Shallow and deep copy operations
 ================================================
 
 .. module:: copy
    :synopsis: Shallow and deep copy operations.
 
+This module provides generic (shallow and deep) copying operations.
 
-.. index::
-   single: copy() (in copy)
-   single: deepcopy() (in copy)
 
-This module provides generic (shallow and deep) copying operations.
+Interface summary:
+
+.. function:: copy(x)
+
+   Return a shallow copy of *x*.
+
+
+.. function:: deepcopy(x)
+
+   Return a deep copy of *x*.
 
-Interface summary::
 
-   import copy
+.. exception:: error
 
-   x = copy.copy(y)        # make a shallow copy of y
-   x = copy.deepcopy(y)    # make a deep copy of y
+   Raised for module specific errors.
 
-For module specific errors, :exc:`copy.error` is raised.
 
 The difference between shallow and deep copying is only relevant for compound
 objects (objects that contain other objects, like lists or class instances):