summaryrefslogtreecommitdiff
path: root/Lib/filecmp.py
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-08-04 13:03:33 -0700
committerGitHub <noreply@github.com>2021-08-04 13:03:33 -0700
commitc2593b4d06712cefcdeae93b32f88faa4772bc3a (patch)
tree70eb5cd0ee255e81693f2752d2f3b8cff28f1a92 /Lib/filecmp.py
parent98f6a72ff621c2033e8f2c38df410e9bfa2b772a (diff)
downloadcpython-git-c2593b4d06712cefcdeae93b32f88faa4772bc3a.tar.gz
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> (cherry picked from commit a8dc4893d2b28827e82447326ea47759c161a722) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
Diffstat (limited to 'Lib/filecmp.py')
-rw-r--r--Lib/filecmp.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/Lib/filecmp.py b/Lib/filecmp.py
index 7c47eb022c..70a4b23c98 100644
--- a/Lib/filecmp.py
+++ b/Lib/filecmp.py
@@ -36,8 +36,9 @@ def cmp(f1, f2, shallow=True):
f2 -- Second file name
- shallow -- Just check stat signature (do not read the files).
- defaults to True.
+ shallow -- treat files as identical if their stat signatures (type, size,
+ mtime) are identical. Otherwise, files are considered different
+ if their sizes or contents differ. [default: True]
Return value: