From a59750f4d6decf2de11aeea0f29b44da1f0547f8 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 9 Sep 2009 16:51:05 +0000 Subject: [PATCH] Merged revisions 74737 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r74737 | georg.brandl | 2009-09-09 18:49:13 +0200 (Mi, 09 Sep 2009) | 1 line Properly document copy and deepcopy as functions. ........ --- Doc/library/copy.rst | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/Doc/library/copy.rst b/Doc/library/copy.rst index e6ad857a732..5ae79aa91d1 100644 --- a/Doc/library/copy.rst +++ b/Doc/library/copy.rst @@ -4,21 +4,25 @@ .. module:: copy :synopsis: Shallow and deep copy operations. - -.. index:: - single: copy() (in copy) - single: deepcopy() (in copy) - This module provides generic (shallow and deep) copying operations. -Interface summary:: - import copy +Interface summary: - x = copy.copy(y) # make a shallow copy of y - x = copy.deepcopy(y) # make a deep copy of y +.. function:: copy(x) + + Return a shallow copy of *x*. + + +.. function:: deepcopy(x) + + Return a deep copy of *x*. + + +.. exception:: error + + 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):