docs(iroh-net): Improve last_pong field docs #2747
Merged
Conversation
This file contains 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
This is a bit confusing, at least this description is closer to the reality. Not mentioning PING_TIMEOUT_DURATION since that is not strictly true, if the socket has signs of being alive but a pong is lost it will still be considered alive and the pong timeout will not be cleared.
We have too many of these already.
divagant-martian
approved these changes
Sep 25, 2024
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2747/docs/iroh/ Last updated: 2024-09-25T09:54:10Z |
|
Both seemed fine to me 😊 |
divagant-martian
approved these changes
Sep 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This is a bit confusing, at least this description is closer to the
reality.
Breaking Changes
None
Notes & open questions
Not mentioning PING_TIMEOUT_DURATION since that is not strictly true,
if the socket has signs of being alive but a pong is lost it will
still be considered alive and the pong timeout will not be cleared.
Change checklist
[ ] Tests if relevant.[ ] All breaking changes documented.