Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More doc-comments 

Fix some more comments on some things
This commit is contained in:
Richard van der Hoff 2016-07-20 15:12:42 +01:00
parent b73dc0ef4d
commit 053e83dafb
2 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
synapse/api/auth.py
View File

@ -566,9 +566,8 @@ class Auth(object):
Args: Args:
request - An HTTP request with an access_token query parameter. request - An HTTP request with an access_token query parameter.
Returns: Returns:
tuple of: defer.Deferred: resolves to a namedtuple including "user" (UserID)
UserID (str) "access_token_id" (int), "is_guest" (bool)
Access token ID (str)
Raises: Raises:
AuthError if no user by that token exists or the token is invalid. AuthError if no user by that token exists or the token is invalid.
""" """

19
synapse/storage/_base.py
View File

@ -597,10 +597,13 @@ class SQLBaseStore(object):
more rows, returning the result as a list of dicts. more rows, returning the result as a list of dicts.
Args: Args:
table : string giving the table name table (str): the table name
keyvalues : dict of column names and values to select the rows with, keyvalues (dict[str, Any] | None):
or None to not apply a WHERE clause. column names and values to select the rows with, or None to not
retcols : list of strings giving the names of the columns to return apply a WHERE clause.
retcols (iterable[str]): the names of the columns to return
Returns:
defer.Deferred: resolves to list[dict[str, Any]]
""" """
return self.runInteraction( return self.runInteraction(
desc, desc,
@ -615,9 +618,11 @@ class SQLBaseStore(object):
Args: Args:
txn : Transaction object txn : Transaction object
table : string giving the table name table (str): the table name
keyvalues : dict of column names and values to select the rows with keyvalues (dict[str, T] | None):
retcols : list of strings giving the names of the columns to return column names and values to select the rows with, or None to not
apply a WHERE clause.
retcols (iterable[str]): the names of the columns to return
""" """
if keyvalues: if keyvalues:
sql = "SELECT %s FROM %s WHERE %s" % ( sql = "SELECT %s FROM %s WHERE %s" % (