]> granicus.if.org Git - python/commitdiff
Clarify what happens if shallow is false. Also, the caching note is not really correc...
authorEli Bendersky <eliben@gmail.com>
Tue, 24 Jul 2012 16:47:34 +0000 (19:47 +0300)
committerEli Bendersky <eliben@gmail.com>
Tue, 24 Jul 2012 16:47:34 +0000 (19:47 +0300)
Doc/library/filecmp.rst

index f84cfa9a2da076085dcb72466d448da8533fef57..ae668ead7dcbe155234f2c2526936b4893d974bf 100644 (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,
    ``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.