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

Commit 6024ed8

Browse files
committed
MSC2918: add missing docstring
1 parent 8f8f369 commit 6024ed8

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

synapse/rest/client/v2_alpha/register.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
)
4848
from synapse.metrics import threepid_send_requests
4949
from synapse.push.mailer import Mailer
50+
from synapse.types import JsonDict
5051
from synapse.util.msisdn import phone_number_to_msisdn
5152
from synapse.util.ratelimitutils import FederationRateLimiter
5253
from synapse.util.stringutils import assert_valid_client_secret, random_string
@@ -708,19 +709,22 @@ async def _do_appservice_registration(
708709

709710
async def _create_registration_details(
710711
self,
711-
user_id,
712-
params,
713-
is_appservice_ghost=False,
712+
user_id: str,
713+
params: JsonDict,
714+
is_appservice_ghost: bool = False,
714715
should_issue_refresh_token: bool = False,
715716
):
716717
"""Complete registration of newly-registered user
717718
718719
Allocates device_id if one was not given; also creates access_token.
719720
720721
Args:
721-
(str) user_id: full canonical @user:id
722-
(object) params: registration parameters, from which we pull
723-
device_id, initial_device_name and inhibit_login
722+
user_id: full canonical @user:id
723+
params: registration parameters, from which we pull device_id,
724+
initial_device_name and inhibit_login
725+
is_appservice_ghost
726+
should_issue_refresh_token: True if this registration should issue
727+
a refresh token alongside the access token.
724728
Returns:
725729
dictionary for response from /register
726730
"""

0 commit comments

Comments
 (0)