(original) (raw)
changeset: 78249:d2a49ee77b6f parent: 78244:c43d73277756 parent: 78248:f6ce142c2fce user: Senthil Kumaran senthil@uthcode.com date: Sun Jul 22 19:31:36 2012 -0700 files: Misc/NEWS description: - Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek. diff -r c43d73277756 -r d2a49ee77b6f Doc/library/filecmp.rst --- a/Doc/library/filecmp.rst Sun Jul 22 20:43:42 2012 -0400 +++ b/Doc/library/filecmp.rst Sun Jul 22 19:31:36 2012 -0700 @@ -75,6 +75,9 @@ '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 @@ 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 @@ .. 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 -r c43d73277756 -r d2a49ee77b6f Misc/NEWS --- a/Misc/NEWS Sun Jul 22 20:43:42 2012 -0400 +++ b/Misc/NEWS Sun Jul 22 19:31:36 2012 -0700 @@ -196,6 +196,9 @@ - Issue #13557: Clarify effect of giving two different namespaces to exec or execfile(). +- Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch + contributed by Chris Jerdonek. + Tests ----- /senthil@uthcode.com