Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Improve the docstrings for the receipts store. #12581

Merged
merged 8 commits into from
Apr 28, 2022
Merged

Improve the docstrings for the receipts store. #12581

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5145bee
Add/update some docstrings.
clokep Apr 27, 2022
06a4d0b
Remove unneeded num_args in @cached decorators.
clokep Apr 28, 2022
fb58d67
Clarify comments.
clokep Apr 28, 2022
6d1d865
More clarifications.
clokep Apr 28, 2022
0501bbc
Attempt to clarify docstring for get_receipts_for_user.
clokep Apr 28, 2022
008a7f4
Fix formatting.
clokep Apr 28, 2022
7a15edc
Fix typo.
clokep Apr 28, 2022
9db3a2d
Fix pluralization.
clokep Apr 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions synapse/storage/databases/main/receipts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ async def get_last_receipt_event_id_for_user(
receipt_type: The receipt type to fetch.

Returns:
The event ID of the latest receipt, if one exists.
The event ID of the latest receipt, if one exists; otherwise `None`.
"""
return await self.db_pool.simple_select_one_onecol(
table="receipts_linearized",
Expand Down Expand Up @@ -197,7 +197,7 @@ async def get_receipts_for_user_with_orderings(
self, user_id: str, receipt_type: str
) -> JsonDict:
"""
Fetch receipts in all rooms for a user.
Fetch receipts for all rooms that the given user is joined to.
clokep marked this conversation as resolved.
Show resolved Hide resolved

Args:
user_id: The user to fetch receipts for.
Expand Down