Document read_details and write_details protocol methods#2702
Merged
Conversation
Add documentation for the read_details and write_details methods in the Custom Protocols section of protocols.md. These methods return diagnostic information about the most recent read/write operations through the protocol, including timestamps and raw data, which is useful for debugging and monitoring interface state. Includes examples from BurstProtocol showing how custom protocols can override these methods to add protocol-specific details. Closes #2522 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2702 +/- ##
=======================================
Coverage 79.31% 79.31%
=======================================
Files 662 662
Lines 52588 52588
Branches 734 734
=======================================
+ Hits 41708 41709 +1
+ Misses 10800 10799 -1
Partials 80 80
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ryanmelt
approved these changes
Jan 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
read_detailsandwrite_detailsmethods in the Custom Protocols section of protocols.mdBurstProtocolshowing how custom protocols can override these methodsCloses #2522
🤖 Generated with Claude Code