Improve documentation in response to review

jkseppan · jkseppan · commit a70081e982b3 · 2017-02-20T14:44:44.000+02:00
No need to point users to private classes
diff --git a/lib/matplotlib/testing/_conversion_cache.py b/lib/matplotlib/testing/_conversion_cache.py
@@ -46,7 +46,9 @@ class _ConversionCache(object):
     """
 
     def __init__(self, directory=None, max_size=int(1e8)):
+        # gets is the set of filenames queried from the cache
         self.gets = set()
+        # hits is the set of filenames found in the cache when queried
         self.hits = set()
         if directory is not None:
             self.cachedir = directory
diff --git a/lib/matplotlib/testing/compare.py b/lib/matplotlib/testing/compare.py
@@ -121,12 +121,12 @@ def comparable_formats():
     return ['png'] + list(converter)
 
 
-@cbook.deprecated('2.1', addendum='Use _ConversionCache instead')
+@cbook.deprecated('2.1')
 def get_cache_dir():
     return ccache._ConversionCache.get_cache_dir()
 
 
-@cbook.deprecated('2.1', addendum='Use _ConversionCache instead')
+@cbook.deprecated('2.1')
 def get_file_hash(path, block_size=2 ** 20):
     if path.endswith('.pdf'):
         from matplotlib import checkdep_ghostscript
