mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-12 15:09:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Clarify what happens if shallow is false. Also, the caching note is not really correct since the cache gets occasionally cleared; therefore I removed it.

Browse source
This commit is contained in:
Eli Bendersky 2012-07-24 19:47:34 +03:00
parent c59cc8f5ea
commit e431ed2354
1 changed files with 2 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/library/filecmp.rst
View file

@ -21,11 +21,8 @@ The :mod:`filecmp` module defines the following functions:
Compare the files named *f1* and *f2*, returning ``True`` if they seem equal, Compare the files named *f1* and *f2*, returning ``True`` if they seem equal,
``False`` otherwise. ``False`` otherwise.
Unless *shallow* is given and is false, files with identical :func:`os.stat` If *shallow* is true, files with identical :func:`os.stat` signatures are
signatures are taken to be equal. taken to be equal. Otherwise, the contents of the files are compared.
Files that were compared using this function will not be compared again unless
their :func:`os.stat` signature changes.
Note that no external programs are called from this function, giving it Note that no external programs are called from this function, giving it
portability and efficiency. portability and efficiency.