Skip to content

Commit f113d68

Browse files
0xNeshiLeoPatOZ
andauthored
docs: Apply suggestions from code review
Co-authored-by: Leo <[email protected]>
1 parent 97f3541 commit f113d68

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

src/event_scanner/scanner/mod.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@
1717
//!
1818
//! ## Backpressure and lag
1919
//!
20-
//! Subscription streams are buffered. If a consumer cannot keep up and the internal broadcast
21-
//! channel drops messages, the corresponding subscription yields [`ScannerError::Lagged`].
20+
//! Subscription streams are buffered. If a consumer processes events too slowly and the
21+
//! internal buffer fills up, the stream yields [`ScannerError::Lagged`] and some events
22+
//! may be skipped.
2223
//!
2324
//! # Reorgs and finality
2425
//!

src/lib.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
//! Event-Scanner is a Rust library for streaming EVM event logs.
1+
//! Event-Scanner is a library made to stream EVM event logs.
22
//!
3-
//! The main entry point is [`EventScanner`], configured via [`EventScannerBuilder`] in one of the
4-
//! supported modes (for example [`Historic`] or [`Live`]). Consumers register one or more event
5-
//! subscriptions via [`EventScanner::subscribe`] and then start the scanner.
3+
//! The main entry point is [`EventScanner`], built via [`EventScannerBuilder`] in one of the
4+
//! supported modes (e.g. [`Historic`] or [`Live`]).
5+
//!
6+
//! After constructing a scanner, register one or more event subscriptions with
7+
//! [`EventScanner::subscribe`], then call [`EventScanner::start`] to begin streaming.
68
//!
79
//! # Stream items
810
//!

0 commit comments

Comments
 (0)