summaryrefslogtreecommitdiffstats
path: root/Lib/filecmp.py
diff options
context:
space:
mode:
authorandrei kulakov <andrei.avk@gmail.com>2021-08-04 19:39:45 (GMT)
committerGitHub <noreply@github.com>2021-08-04 19:39:45 (GMT)
commita8dc4893d2b28827e82447326ea47759c161a722 (patch)
treed0fd9c1ea3f5c88240a8134cc5e1bab3a98521a9 /Lib/filecmp.py
parent7c5dab4340032eb15d3797d8b601ef11649bbab3 (diff)
downloadcpython-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 '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 7c47eb0..70a4b23 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: