diff options
| author | andrei kulakov <andrei.avk@gmail.com> | 2021-08-04 19:39:45 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-04 19:39:45 (GMT) |
| commit | a8dc4893d2b28827e82447326ea47759c161a722 (patch) | |
| tree | d0fd9c1ea3f5c88240a8134cc5e1bab3a98521a9 /Doc | |
| parent | 7c5dab4340032eb15d3797d8b601ef11649bbab3 (diff) | |
| download | cpython-a8dc4893d2b28827e82447326ea47759c161a722.zip cpython-a8dc4893d2b28827e82447326ea47759c161a722.tar.gz cpython-a8dc4893d2b28827e82447326ea47759c161a722.tar.bz2 | |
bpo-42958: Improve description of shallow= in filecmp.cmp docs (GH-27166)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Alexander Vandenbulcke <alexander.vandenbulcke95@gmail.com>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/filecmp.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst index c60603b..83e9e14 100644 --- a/Doc/library/filecmp.rst +++ b/Doc/library/filecmp.rst @@ -22,8 +22,11 @@ The :mod:`filecmp` module defines the following functions: Compare the files named *f1* and *f2*, returning ``True`` if they seem equal, ``False`` otherwise. - If *shallow* is true, files with identical :func:`os.stat` signatures are - taken to be equal. Otherwise, the contents of the files are compared. + If *shallow* is true and the :func:`os.stat` signatures (file type, size, and + modification time) of both files are identical, the files are taken to be + equal. + + Otherwise, the files are treated as different if their sizes or contents differ. Note that no external programs are called from this function, giving it portability and efficiency. |