mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 01:00:54 +00:00
use google style doc strings
This commit is contained in:
parent
a2866e2e6a
commit
35b5c4ba1b
1 changed files with 12 additions and 11 deletions
|
@ -49,17 +49,18 @@ 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:
|
||||||
initial value of the generator from.
|
db_conn(connection): A database connection to use to fetch the
|
||||||
:param str table: A database table to read the initial value of the id
|
initial value of the generator from.
|
||||||
generator from.
|
table(str): A database table to read the initial value of the id
|
||||||
:param str column: The column of the database table to read the initial
|
generator from.
|
||||||
value from the id generator from.
|
column(str): The column of the database table to read the initial
|
||||||
:param list extra_tables: List of pairs of database tables and columns to
|
value from the id generator from.
|
||||||
use to source the initial value of the generator from. The value with
|
extra_tables(list): List of pairs of database tables and columns to
|
||||||
the largest magnitude is used.
|
use to source the initial value of the generator from. The value
|
||||||
:param int step: which direction the stream ids grow in. +1 to grow
|
with the largest magnitude is used.
|
||||||
upwards, -1 to grow downwards.
|
step(int): which direction the stream ids grow in. +1 to grow
|
||||||
|
upwards, -1 to grow downwards.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
with stream_id_gen.get_next() as stream_id:
|
with stream_id_gen.get_next() as stream_id:
|
||||||
|
|
Loading…
Reference in a new issue