whatsnew: filecmp.clear_cache, and reword description of cache in docs.

This commit is contained in:
R David Murray 2014-02-02 11:11:01 -05:00
parent 70e04f5fbc
commit 4885f49e7f
3 changed files with 17 additions and 6 deletions

View file

@ -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: