diff options
| author | reivilibre <oliverw@matrix.org> | 2022-11-15 10:43:17 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-15 10:43:17 +0000 |
| commit | 634359b083eae319d7f065114851590431b7c7fb (patch) | |
| tree | 8e3728ab93980401edef43778a2a9e0a478f5efc | |
| parent | Include additional TURN server example into documentation (#14293) (diff) | |
| download | synapse-634359b083eae319d7f065114851590431b7c7fb.tar.xz | |
Update docstring to clarify that `get_partial_state_events_batch` does not just give you completely arbitrary partial-state events. (#14417)
| -rw-r--r-- | changelog.d/14417.misc | 1 | ||||
| -rw-r--r-- | synapse/storage/databases/main/events_worker.py | 10 |
2 files changed, 10 insertions, 1 deletions
diff --git a/changelog.d/14417.misc b/changelog.d/14417.misc new file mode 100644 index 0000000000..7527fe97c2 --- /dev/null +++ b/changelog.d/14417.misc @@ -0,0 +1 @@ +Update docstring to clarify that `get_partial_state_events_batch` does not just give you completely arbitrary partial-state events. \ No newline at end of file diff --git a/synapse/storage/databases/main/events_worker.py b/synapse/storage/databases/main/events_worker.py index 7a003ab88f..296e50d661 100644 --- a/synapse/storage/databases/main/events_worker.py +++ b/synapse/storage/databases/main/events_worker.py @@ -2228,7 +2228,15 @@ class EventsWorkerStore(SQLBaseStore): return result is not None async def get_partial_state_events_batch(self, room_id: str) -> List[str]: - """Get a list of events in the given room that have partial state""" + """ + Get a list of events in the given room that: + - have partial state; and + - are ready to be resynced (because they have no prev_events that are + partial-stated) + + See the docstring on `_get_partial_state_events_batch_txn` for more + information. + """ return await self.db_pool.runInteraction( "get_partial_state_events_batch", self._get_partial_state_events_batch_txn, |