diff options
author | Mark Haines <mark.haines@matrix.org> | 2016-04-01 16:08:59 +0100 |
---|---|---|
committer | Mark Haines <mark.haines@matrix.org> | 2016-04-01 16:12:07 +0100 |
commit | 2a37467fa1358eb41513893efe44cbd294dca36c (patch) | |
tree | 5d07ebcf930104318f74862ba54db5074a23917b /synapse/storage/registration.py | |
parent | Merge pull request #680 from matrix-org/markjh/remove_is_new_state (diff) | |
download | synapse-2a37467fa1358eb41513893efe44cbd294dca36c.tar.xz |
Use google style doc strings.
pycharm supports them so there is no need to use the other format. Might as well convert the existing strings to reduce the risk of people accidentally cargo culting the wrong doc string format.
Diffstat (limited to 'synapse/storage/registration.py')
-rw-r--r-- | synapse/storage/registration.py | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/synapse/storage/registration.py b/synapse/storage/registration.py index bd4eb88a92..d46a963bb8 100644 --- a/synapse/storage/registration.py +++ b/synapse/storage/registration.py @@ -458,12 +458,15 @@ class RegistrationStore(SQLBaseStore): """ Gets the 3pid's guest access token if exists, else saves access_token. - :param medium (str): Medium of the 3pid. Must be "email". - :param address (str): 3pid address. - :param access_token (str): The access token to persist if none is - already persisted. - :param inviter_user_id (str): User ID of the inviter. - :return (deferred str): Whichever access token is persisted at the end + Args: + medium (str): Medium of the 3pid. Must be "email". + address (str): 3pid address. + access_token (str): The access token to persist if none is + already persisted. + inviter_user_id (str): User ID of the inviter. + + Returns: + deferred str: Whichever access token is persisted at the end of this function call. """ def insert(txn): |