Describe prune_unread_entries in docstrings (#11876)

Should have been caught in #10826.
This commit is contained in:
David Robertson 2022-02-02 15:11:23 +00:00 committed by GitHub
parent acda9f07c8
commit f510fba4ba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 2 deletions

View file

@ -254,9 +254,17 @@ class DeferredCacheDescriptor(_CacheDescriptorBase):
return r1 + r2
Args:
orig:
max_entries:
num_args: number of positional arguments (excluding ``self`` and
``cache_context``) to use as cache keys. Defaults to all named
args of the function.
tree:
cache_context:
iterable:
prune_unread_entries: If True, cache entries that haven't been read recently
will be evicted from the cache in the background. Set to False to opt-out
of this behaviour.
"""
def __init__(