mirror of
https://github.com/element-hq/synapse
synced 2024-09-04 12:30:06 +00:00
Expand docstring a bit
This commit is contained in:
parent
ffad4fe35b
commit
093f7e47cc
1 changed files with 7 additions and 1 deletions
|
@ -1344,11 +1344,17 @@ class EventsStore(SQLBaseStore):
|
||||||
self._get_event_cache.invalidate((event_id,))
|
self._get_event_cache.invalidate((event_id,))
|
||||||
|
|
||||||
def _get_events_from_cache(self, events, allow_rejected, update_metrics=True):
|
def _get_events_from_cache(self, events, allow_rejected, update_metrics=True):
|
||||||
"""
|
"""Fetch events from the caches
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
events (list(str)): list of event_ids to fetch
|
events (list(str)): list of event_ids to fetch
|
||||||
allow_rejected (bool): Whether to teturn events that were rejected
|
allow_rejected (bool): Whether to teturn events that were rejected
|
||||||
update_metrics (bool): Whether to update the cache hit ratio metrics
|
update_metrics (bool): Whether to update the cache hit ratio metrics
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict of event_id -> _EventCacheEntry for each event_id in cache. If
|
||||||
|
allow_rejected is `False` then there will still be an entry but it
|
||||||
|
will be `None`
|
||||||
"""
|
"""
|
||||||
event_map = {}
|
event_map = {}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue