diff options
| author | Eli Bendersky <eliben@gmail.com> | 2012-07-24 16:47:34 (GMT) |
|---|---|---|
| committer | Eli Bendersky <eliben@gmail.com> | 2012-07-24 16:47:34 (GMT) |
| commit | e431ed23544214a336a556dfa8e080e26d445fd5 (patch) | |
| tree | 4f852a457fb4c75b286f7b166f9abdc60f35245b /Doc/library/filecmp.rst | |
| parent | c59cc8f5ea4f5a7a1bf592fbca662e0f305bceef (diff) | |
| download | cpython-e431ed23544214a336a556dfa8e080e26d445fd5.zip cpython-e431ed23544214a336a556dfa8e080e26d445fd5.tar.gz cpython-e431ed23544214a336a556dfa8e080e26d445fd5.tar.bz2 | |
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.
Diffstat (limited to 'Doc/library/filecmp.rst')
| -rw-r--r-- | Doc/library/filecmp.rst | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst index f84cfa9..ae668ea 100644 --- a/Doc/library/filecmp.rst +++ b/Doc/library/filecmp.rst @@ -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, ``False`` otherwise. - Unless *shallow* is given and is false, files with identical :func:`os.stat` - signatures are taken to be equal. - - Files that were compared using this function will not be compared again unless - their :func:`os.stat` signature changes. + If *shallow* is true, files with identical :func:`os.stat` signatures are + taken to be equal. Otherwise, the contents of the files are compared. Note that no external programs are called from this function, giving it portability and efficiency. |