- Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contribu...
authorSenthil Kumaran <senthil@uthcode.com>
Mon, 23 Jul 2012 02:12:58 +0000 (19:12 -0700)
committerSenthil Kumaran <senthil@uthcode.com>
Mon, 23 Jul 2012 02:12:58 +0000 (19:12 -0700)
Doc/library/filecmp.rst
Misc/NEWS

index e0ffff704ece8dd9b09db1b0721bef1de912f9a1..f84cfa9a2da076085dcb72466d448da8533fef57 100644 (file)
@@ -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
index 0b607db85825b551e91efda7eeeab17065f38ec3..d8a581bc40ffdd5c8144f598fec85dbf41d595a9 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -424,6 +424,9 @@ Documentation
 
 - Issue #14034: added the argparse tutorial.
 
+- Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch
+  contributed by Chris Jerdonek.
+
 Tools/Demos
 -----------