From: Senthil Kumaran <senthil@uthcode.com>
Date: Mon, 23 Jul 2012 02:36:03 +0000 (-0700)
Subject: Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contribute... 
X-Git-Tag: v2.7.4rc1~692
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0c472c3271b20a1215cecd7ef8326a52de5e9541;p=thirdparty%2FPython%2Fcpython.git

Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek.
---

diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst
index 25d0701af379..cc68319cf367 100644
--- a/Doc/library/filecmp.rst
+++ b/Doc/library/filecmp.rst
@@ -75,6 +75,9 @@ The :class:`dircmp` class
    'tags']``. *hide* is a list of names to hide, and defaults to ``[os.curdir,
    os.pardir]``.
 
+   The :class:`dircmp` class compares files by doing *shallow* comparisons
+   as described for :func:`filecmp.cmp`.
+
    The :class:`dircmp` class provides the following methods:
 
 
@@ -94,7 +97,7 @@ The :class:`dircmp` class
       Print a comparison between *a* and *b* and common subdirectories
       (recursively).
 
-   The :class:`dircmp` offers a number of interesting attributes that may be
+   The :class:`dircmp` class offers a number of interesting attributes that may be
    used to get various bits of information about the directory trees being
    compared.
 
@@ -146,12 +149,14 @@ The :class:`dircmp` class
 
    .. attribute:: same_files
 
-      Files which are identical in both *a* and *b*.
+      Files which are identical in both *a* and *b*, using the class's
+      file comparison operator.
 
 
    .. attribute:: diff_files
 
-      Files which are in both *a* and *b*, whose contents differ.
+      Files which are in both *a* and *b*, whose contents differ according
+      to the class's file comparison operator.
 
 
    .. attribute:: funny_files
diff --git a/Misc/NEWS b/Misc/NEWS
index 16f0a682dbe5..a279941eb35c 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -304,12 +304,16 @@ Build
 - Issue #14437: Fix building the _io module under Cygwin.
 
 Documentation
+-------------
 
 - Issue #13557: Clarify effect of giving two different namespaces to exec or
   execfile().
 
 - Issue #14034: added the argparse tutorial.
 
+- Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch
+  contributed by Chris Jerdonek.
+
 
 What's New in Python 2.7.3 release candidate 2?
 ===============================================