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.
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
Jepsen/mdbook #2297
Jepsen/mdbook #2297
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
High-level changes:
It would be good to route users to the abigen!
-based interfaces for accessing these tools, as they're simpler and higher level. This documentation is a good explanation of how abigen works under the hood
We should also mention the difference between Event::stream
and Event::subscribe
. the stream
interface is polling, and will work with any provider, but have increased cost and latency. Subscribe is based on WS/IPC notifications, and is limited to those providers
Thanks for the feedback, I went and made some of the easy changes. I have yet to distinguish the difference between |
did you intend to do this as part of this PR? or in a future one? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is at risk of getting stale, I'm going to re-run CI and merge if succesful. Followup work can be a separate PR
CI failures unrelated |
I added some more to the documentation here
contributes to #2282