Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-07-15 05:54:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

use google style doc strings

Browse source
This commit is contained in:
Mark Haines 2016-04-01 15:07:01 +01:00
parent a2866e2e6a
commit 35b5c4ba1b
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
synapse/storage/util/id_generators.py
View file

@ -49,16 +49,17 @@ class StreamIdGenerator(object):
all ids less than or equal to it have completed. This handles the fact that all ids less than or equal to it have completed. This handles the fact that
persistence of events can complete out of order. persistence of events can complete out of order.
:param connection db_conn: A database connection to use to fetch the Args:
db_conn(connection): A database connection to use to fetch the
initial value of the generator from. initial value of the generator from.
:param str table: A database table to read the initial value of the id table(str): A database table to read the initial value of the id
generator from. generator from.
:param str column: The column of the database table to read the initial column(str): The column of the database table to read the initial
value from the id generator from. value from the id generator from.
:param list extra_tables: List of pairs of database tables and columns to extra_tables(list): List of pairs of database tables and columns to
use to source the initial value of the generator from. The value with use to source the initial value of the generator from. The value
the largest magnitude is used. with the largest magnitude is used.
:param int step: which direction the stream ids grow in. +1 to grow step(int): which direction the stream ids grow in. +1 to grow
upwards, -1 to grow downwards. upwards, -1 to grow downwards.
Usage: Usage: