diff options
| author | R David Murray <rdmurray@bitdance.com> | 2014-02-02 11:11:01 -0500 |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2014-02-02 11:11:01 -0500 |
| commit | 4885f49e7fcef35ad25c50f4c6876c56e2a9f545 (patch) | |
| tree | fe1b3367a3a5585596a2cd72f7e4df7eefe78138 /Doc/library/filecmp.rst | |
| parent | 70e04f5fbc0b62c4d1d04fd982204437120f791d (diff) | |
| download | cpython-git-4885f49e7fcef35ad25c50f4c6876c56e2a9f545.tar.gz | |
whatsnew: filecmp.clear_cache, and reword description of cache in docs.
Diffstat (limited to 'Doc/library/filecmp.rst')
| -rw-r--r-- | Doc/library/filecmp.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst index 8471a72630..06d3f21300 100644 --- a/Doc/library/filecmp.rst +++ b/Doc/library/filecmp.rst @@ -28,8 +28,8 @@ The :mod:`filecmp` module defines the following functions: portability and efficiency. This function uses a cache for past comparisons and the results, - with a cache invalidation mechanism relying on stale signatures - or by explicitly calling :func:`clear_cache`. + with cache entries invalidated if the :func:`os.stat` information for the + file changes. The entire cache may be cleared using :func:`clear_cache`. .. function:: cmpfiles(dir1, dir2, common, shallow=True) @@ -54,12 +54,12 @@ The :mod:`filecmp` module defines the following functions: .. function:: clear_cache() - .. versionadded:: 3.4 - Clear the filecmp cache. This may be useful if a file is compared so quickly after it is modified that it is within the mtime resolution of the underlying filesystem. + .. versionadded:: 3.4 + .. _dircmp-objects: |