Fill in docstrings

This commit is contained in:
Eric Eastwood 2024-08-15 23:52:01 -05:00
parent 2ec93e3f0d
commit c89d859c7c
2 changed files with 11 additions and 4 deletions

View file

@ -1565,7 +1565,10 @@ class PersistEventsStore:
Fetch the current state event IDs for the relevant (to the
`sliding_sync_joined_rooms` table) state types for the given room.
TODO
Returns:
StateMap of event IDs necessary to to fetch the relevant state values needed
to insert into the
`sliding_sync_joined_rooms`/`sliding_sync_membership_snapshots`.
"""
# Fetch the current state event IDs from the database
(
@ -1597,7 +1600,9 @@ class PersistEventsStore:
cls, txn: LoggingTransaction, state_map: StateMap[str]
) -> Dict[str, Optional[Union[str, bool]]]:
"""
TODO
Fetch events in the `state_map` and extract the relevant state values needed to
insert into the `sliding_sync_joined_rooms`/`sliding_sync_membership_snapshots`
tables.
Returns:
Map from column names (`room_type`, `is_encrypted`, `room_name`) to relevant
@ -1661,7 +1666,8 @@ class PersistEventsStore:
cls, txn: LoggingTransaction, unsigned_stripped_state_events: Any
) -> Dict[str, Optional[Union[str, bool]]]:
"""
TODO
Pull out the relevant state values from the stripped state needed to insert into
the `sliding_sync_membership_snapshots` tables.
Returns:
Map from column names (`room_type`, `is_encrypted`, `room_name`) to relevant

View file

@ -144,7 +144,8 @@ Changes in SCHEMA_VERSION = 86
- Add a column `authenticated` to the tables `local_media_repository` and `remote_media_cache`
Changes in SCHEMA_VERSION = 87
- TODO
- Add tables to store Sliding Sync data for quick filtering/sorting
(`sliding_sync_joined_rooms`, `sliding_sync_membership_snapshots`)
"""