diff options
author | Thomas Kemmer <tkemmer@computer.org> | 2021-09-27 22:19:42 +0200 |
---|---|---|
committer | Thomas Kemmer <tkemmer@computer.org> | 2021-09-27 22:19:42 +0200 |
commit | 7ae6ef5749db9138a555edf58d6b01b6778cf6ad (patch) | |
tree | 925fc426879d0d34477ab7a3874819d2139db6f5 | |
parent | be507a6234ac6f48ed84052a414e38dfb22aaa8a (diff) | |
download | cachetools-7ae6ef5749db9138a555edf58d6b01b6778cf6ad.tar.gz |
Explicitly specify autoclass members.
-rw-r--r-- | docs/index.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/index.rst b/docs/index.rst index 1c4d05b..147a19f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -67,7 +67,7 @@ computed when the item is inserted into the cache. suitable `lock` object. .. autoclass:: Cache(maxsize, getsizeof=None) - :members: + :members: currsize, getsizeof, maxsize This class discards arbitrary items using :meth:`popitem` to make space when necessary. Derived classes may override :meth:`popitem` @@ -77,31 +77,31 @@ computed when the item is inserted into the cache. :meth:`__setitem__` and :meth:`__delitem__`. .. autoclass:: FIFOCache(maxsize, getsizeof=None) - :members: + :members: popitem This class evicts items in the order they were added to make space when necessary. .. autoclass:: LFUCache(maxsize, getsizeof=None) - :members: + :members: popitem This class counts how often an item is retrieved, and discards the items used least often to make space when necessary. .. autoclass:: LRUCache(maxsize, getsizeof=None) - :members: + :members: popitem This class discards the least recently used items first to make space when necessary. .. autoclass:: MRUCache(maxsize, getsizeof=None) - :members: + :members: popitem This class discards the most recently used items first to make space when necessary. .. autoclass:: RRCache(maxsize, choice=random.choice, getsizeof=None) - :members: + :members: choice, popitem This class randomly selects candidate items and discards them to make space when necessary. |