8000 - Issue #15250: Document that filecmp.dircmp compares files shallowly… · python/cpython@28a9f21 · GitHub
[go: up one dir, main page]

Skip to content

Commit 28a9f21

Browse files
committed
- Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch contributed by Chris Jerdonek.
1 parent e60e12b commit 28a9f21

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

Doc/library/filecmp.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ The :class:`dircmp` class
7575
'tags']``. *hide* is a list of names to hide, and defaults to ``[os.curdir,
7676
os.pardir]``.
7777

78+
The :class:`dircmp` class compares files by doing *shallow* comparisons
79+
as described for :func:`filecmp.cmp`.
80+
7881
The :class:`dircmp` class provides the following methods:
7982

8083

@@ -94,7 +97,7 @@ The :class:`dircmp` class
9497
Print a comparison between *a* and *b* and common subdirectories
9598
(recursively).
9699

97-
The :class:`dircmp` offers a number of interesting attributes that may be
100+
The :class:`dircmp` class offers a number of interesting attributes that may be
98101
used to get various bits of information about the directory trees being
99102
compared.
100103

@@ -146,12 +149,14 @@ The :class:`dircmp` class
146149

147150
.. attribute:: same_files
148151

149-
Files which are identical in both *a* and *b*.
152+
Files which are identical in both *a* and *b*, using the class's
153+
file comparison operator.
150154

151155

152156
.. attribute:: diff_files
153157

154-
Files which are in both *a* and *b*, whose contents differ.
158+
Files which are in both *a* and *b*, whose contents differ according
159+
to the class's file comparison operator.
155160

156161

157162
.. attribute:: funny_files

Misc/NEWS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,9 @@ Documentation
424424

425425
- Issue #14034: added the argparse tutorial.
426426

427+
- Issue #15250: Document that filecmp.dircmp compares files shallowly. Patch
428+
contributed by Chris Jerdonek.
429+
427430
Tools/Demos
428431
-----------
429432

0 commit comments

Comments
 (0)
0