From 04bd926923ebf561b88550b280bfc05e1385f8d3 Mon Sep 17 00:00:00 2001 From: Seun LanLege Date: Fri, 22 Nov 2019 13:45:05 +0100 Subject: [PATCH] Better docs for TxPool::import_notification_stream (#4157) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * better docs for import_notification_stream * Apply suggestions from code review Co-Authored-By: Tomasz Drwięga --- substrate/client/transaction-pool/graph/src/pool.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/substrate/client/transaction-pool/graph/src/pool.rs b/substrate/client/transaction-pool/graph/src/pool.rs index c6e3322328..cc1751102d 100644 --- a/substrate/client/transaction-pool/graph/src/pool.rs +++ b/substrate/client/transaction-pool/graph/src/pool.rs @@ -279,7 +279,10 @@ impl Pool { ))) } - /// Return an event stream of transactions imported to the pool. + /// Return an event stream of notifications for when transactions are imported to the pool. + /// + /// Consumers of this stream should use the `ready` method to actually get the + /// pending transactions in the right order. pub fn import_notification_stream(&self) -> EventStream { self.validated_pool.import_notification_stream() }