diff options
| author | David Robertson <davidr@element.io> | 2022-02-02 15:11:23 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-02 15:11:23 +0000 |
| commit | f510fba4ba9d0ebf0c062f0a561da19b2ea0c2d6 (patch) | |
| tree | 755e958372e57767cd8acb984884d09039cfa94c /synapse/util/caches/descriptors.py | |
| parent | Revert experimental push rules from #7997. (#11884) (diff) | |
| download | synapse-f510fba4ba9d0ebf0c062f0a561da19b2ea0c2d6.tar.xz | |
Describe `prune_unread_entries` in docstrings (#11876)
Should have been caught in #10826.
Diffstat (limited to 'synapse/util/caches/descriptors.py')
| -rw-r--r-- | synapse/util/caches/descriptors.py | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/synapse/util/caches/descriptors.py b/synapse/util/caches/descriptors.py index 375cd443f1..df4fb156c2 100644 --- a/synapse/util/caches/descriptors.py +++ b/synapse/util/caches/descriptors.py @@ -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__( |