[docs] [issue15250] document that filecmp.dircmp comparisons are "shallow"

Chris Jerdonek report at bugs.python.org
Wed Jul 4 16:36:07 CEST 2012

New submission from Chris Jerdonek <chris.jerdonek at gmail.com>:

The documentation for the dircmp class doesn't say that the same_files and diff_files attributes are determined using the "shallow=True" rules described in the filecmp.cmp() and filecmp.cmpfiles().  It should say this.

For example, the documentation describes diff_files as, "Files which are in both a and b, whose contents differ."  But this isn't true since files whose contents differ aren't included if their os.stat() signatures are equal.

See also issue 12932 to allow dircmp to perform non-shallow comparisons.

assignee: docs at python
components: Documentation
keywords: easy
messages: 164646
nosy: cjerdonek, docs at python
priority: normal
severity: normal
status: open
title: document that filecmp.dircmp comparisons are "shallow"
versions: Python 3.3

Python tracker <report at bugs.python.org>

More information about the docs mailing list