Add docstring for received payments client class (#1738)

This commit is contained in:
Jonathan Zernik 2021-10-26 21:24:12 -07:00 committed by GitHub
parent c51a1a82be
commit a442b3eb17
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -31,6 +31,13 @@ DEFAULT_UPDATE_INTERVAL_S = 1
class ReceivedPaymentsSubscriptionClient:
"""Class that can be used to get a subscription to a stream
of received payments.
`initial_index` parameter refers to the `received_payment_id` that will be
the first in the result stream.
"""
def __init__(
self,
squeak_db,