From a442b3eb17d707ebb678a64702bb2b35f1cd0efb Mon Sep 17 00:00:00 2001 From: Jonathan Zernik Date: Tue, 26 Oct 2021 21:24:12 -0700 Subject: [PATCH] Add docstring for received payments client class (#1738) --- squeaknode/node/received_payments_subscription_client.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/squeaknode/node/received_payments_subscription_client.py b/squeaknode/node/received_payments_subscription_client.py index 3f38b90c..34d9e940 100644 --- a/squeaknode/node/received_payments_subscription_client.py +++ b/squeaknode/node/received_payments_subscription_client.py @@ -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,