diff options
| author | Richard van der Hoff <richard@matrix.org> | 2016-07-20 15:12:42 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2016-07-20 16:40:28 +0100 |
| commit | 053e83dafb8d66b010a087d57b0aac108d68036e (patch) | |
| tree | af274e64fd708f39b4db647a9ebb9f2d0cedda43 /synapse/storage | |
| parent | Merge pull request #936 from matrix-org/erikj/log_rss (diff) | |
| download | synapse-053e83dafb8d66b010a087d57b0aac108d68036e.tar.xz | |
More doc-comments
Fix some more comments on some things
Diffstat (limited to 'synapse/storage')
| -rw-r--r-- | synapse/storage/_base.py | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/synapse/storage/_base.py b/synapse/storage/_base.py index d766a30299..0117fdc639 100644 --- a/synapse/storage/_base.py +++ b/synapse/storage/_base.py @@ -597,10 +597,13 @@ class SQLBaseStore(object): more rows, returning the result as a list of dicts. Args: - table : string giving the table name - keyvalues : dict of column names and values to select the rows with, - or None to not apply a WHERE clause. - retcols : list of strings giving the names of the columns to return + table (str): the table name + keyvalues (dict[str, Any] | None): + 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 + Returns: + defer.Deferred: resolves to list[dict[str, Any]] """ return self.runInteraction( desc, @@ -615,9 +618,11 @@ class SQLBaseStore(object): Args: txn : Transaction object - table : string giving the table name - keyvalues : dict of column names and values to select the rows with - retcols : list of strings giving the names of the columns to return + table (str): the table name + keyvalues (dict[str, T] | None): + 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: sql = "SELECT %s FROM %s WHERE %s" % ( |