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

This commit is contained in:
Senthil Kumaran 2012-07-22 19:36:03 -07:00
parent 0f111c13cd
commit 0c472c3271
2 changed files with 12 additions and 3 deletions

View File

@ -75,6 +75,9 @@ The :class:`dircmp` class
'tags']``. *hide* is a list of names to hide, and defaults to ``[os.curdir, 'tags']``. *hide* is a list of names to hide, and defaults to ``[os.curdir,
os.pardir]``. 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: 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 Print a comparison between *a* and *b* and common subdirectories
(recursively). (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 used to get various bits of information about the directory trees being
compared. compared.
@ -146,12 +149,14 @@ The :class:`dircmp` class
.. attribute:: same_files .. 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 .. 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 .. attribute:: funny_files

View File

@ -304,12 +304,16 @@ Build
- Issue #14437: Fix building the _io module under Cygwin. - Issue #14437: Fix building the _io module under Cygwin.
Documentation Documentation
-------------
- Issue #13557: Clarify effect of giving two different namespaces to exec or - Issue #13557: Clarify effect of giving two different namespaces to exec or
execfile(). execfile().
- Issue #14034: added the argparse tutorial. - 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? What's New in Python 2.7.3 release candidate 2?
=============================================== ===============================================