From 0c472c3271b20a1215cecd7ef8326a52de5e9541 Mon Sep 17 00:00:00 2001 From: Senthil Kumaran Date: Sun, 22 Jul 2012 19:36:03 -0700 Subject: [PATCH] Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek. --- Doc/library/filecmp.rst | 11 ++++++++--- Misc/NEWS | 4 ++++ 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst index 25d0701af37..cc68319cf36 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 16f0a682dbe..a279941eb35 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? ===============================================