Docs improvements #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

LeoPatOZ merged 29 commits into main from docs-improvements

Dec 18, 2025

Collaborator

0xNeshi commented Dec 16, 2025 •

edited

Loading

Resolves #256
Resolves #260

#266 somehow reverted #268 , so this PR adds it back...

0xNeshi self-assigned this

0xNeshi requested review from LeoPatOZ and pepebndc as code owners

December 16, 2025 10:41

0xNeshi mentioned this pull request

fix: stream Lagged errors up to the caller #263

Closed

LeoPatOZ reviewed

View reviewed changes

src/lib.rs Outdated Show resolved Hide resolved

LeoPatOZ reviewed

View reviewed changes

src/lib.rs Outdated Show resolved Hide resolved

LeoPatOZ reviewed

View reviewed changes

src/lib.rs Outdated Show resolved Hide resolved

LeoPatOZ reviewed

View reviewed changes

src/event_scanner/scanner/sync/from_block.rs Outdated Show resolved Hide resolved

LeoPatOZ reviewed

View reviewed changes

src/event_scanner/scanner/mod.rs Outdated Show resolved Hide resolved

LeoPatOZ reviewed

View reviewed changes

src/block_range_scanner.rs Outdated Show resolved Hide resolved

0xNeshi commented

View reviewed changes

src/event_scanner/scanner/common.rs Show resolved Hide resolved

0xNeshi force-pushed the docs-improvements branch from f66f636 to e56c03c Compare

December 17, 2025 06:55

0xNeshi requested a review from LeoPatOZ

December 17, 2025 06:58

LeoPatOZ reviewed

View reviewed changes

src/event_scanner/scanner/mod.rs Outdated Show resolved Hide resolved

LeoPatOZ reviewed

View reviewed changes

src/lib.rs Show resolved Hide resolved

0xNeshi requested a review from LeoPatOZ

December 17, 2025 09:47

LeoPatOZ reviewed

View reviewed changes

src/robust_provider/provider.rs Outdated Show resolved Hide resolved

0xNeshi requested a review from LeoPatOZ

December 18, 2025 07:09

0xNeshi added 12 commits

December 18, 2025 11:01


          move common_ancestor related docs above the field

9010ae3


          fix: stream Lagged errors up to the caller

0dbc70e


          add missing mod docs to src/lib.rs

c989923


          add missing mod docs to src/event_scanner/scanner/mod.rs

ed0e2aa


          add missing mod and doc comments

9fc1e1f


          add missing pub API docs

83a448f


          clippy: inline listener in spawn fns

d1fc0c6


          docs: clarify why handle_stream waits on consumer (thread) sets

cfe2a5c


          Revert "clippy: inline listener in spawn fns"

eb28119

This reverts commit 35d37f9.


          Revert "Revert "clippy: inline listener in spawn fns""

78bcabf

This reverts commit ba91b7c.


          Revert "remove block_confirmations from latest events"

943f365

This reverts commit 9fad1dc.


          Revert "fix: stream Lagged errors up to the caller"

64a8b64

This reverts commit ec2d928.

0xNeshi and others added 10 commits

December 18, 2025 11:04


          remove unused DEFAULT_REORG_REWIND_DEPTH const

996f9ba


          docs: Apply suggestions from code review

a732564

Co-authored-by: Leo <[email protected]>


          docs: reword duplicate event possibility description

2eedfe9


          docs: move start-related docs to EventScanner + list specific possibl…

60e5b54

…e errors


          ref: rename generic param 'M' to 'Mode'

9e3e4e4


          docs: link to mode function creators in Mode docs

85e417f


          clippy

8bdc3a5


          ref: try_operation_with_failover

e384058


          specify exact errors in robust provider error docs

acda174


          expose try_operation_with_failover publicly

7d48e5a

0xNeshi force-pushed the docs-improvements branch from 5dcbef8 to 7d48e5a Compare

December 18, 2025 10:06

0xNeshi added 3 commits

December 18, 2025 11:08


          ref: move derive below doc comment on Synchronize struct

ec63456


          Revert "expose try_operation_with_failover publicly"

e441e2e

This reverts commit 7d48e5a.


          ref: revert try_operation_with_failover ref

This was referenced Dec 18, 2025

Refactor try_operation_with_failover and Expose It and CoreError publicly from RobustProvider #271

Merged

Expose try_operation_with_failover + CoreError publicly from RobustProvider #272

Closed

LeoPatOZ previously approved these changes

View reviewed changes

Collaborator

LeoPatOZ left a comment

Sweet thanks for doing this


          fix conflicts

be1b48b

0xNeshi dismissed LeoPatOZ’s stale review via

be1b48b

December 18, 2025 10:56

LeoPatOZ previously approved these changes

View reviewed changes


          merge: fix conflict

309b952

0xNeshi dismissed LeoPatOZ’s stale review via

309b952

December 18, 2025 11:05

0xNeshi requested a review from LeoPatOZ

December 18, 2025 11:08

LeoPatOZ previously approved these changes

View reviewed changes


          merge: fix conflicts

cad3330

0xNeshi dismissed LeoPatOZ’s stale review via

cad3330

December 18, 2025 11:17

0xNeshi requested a review from LeoPatOZ

December 18, 2025 11:17

LeoPatOZ approved these changes

View reviewed changes

LeoPatOZ merged commit 9b8e077 into main

13 checks passed

LeoPatOZ deleted the docs-improvements branch

December 18, 2025 11:24

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet