Clarify comments.

Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
This commit is contained in:
Patrick Cloke 2023-01-25 16:45:01 -05:00 committed by David Robertson
parent 528183bb55
commit 1ce0bd2d77
No known key found for this signature in database
GPG key ID: 903ECE108A39DEDD

View file

@ -1278,9 +1278,9 @@ class RoomWorkerStore(CacheInvalidationWorkerStore):
async def is_partial_state_rooms(
self, room_ids: StrCollection
) -> Mapping[str, bool]:
"""Checks if this room has partial state.
"""Checks if the given rooms have partial state.
Returns true if this is a "partial-state" room, which means that the state
Returns true for "partial-state" rooms, which means that the state
at events in the room, and `current_state_events`, may not yet be
complete.
"""