docs: sync package docs to sdk.host.getBridgeAddress - #39
Merged
Merged
Conversation
The docs still described the local helper this package no longer has, and in places asserted its internals — reading `net.assignedPort`, "never `addressInfo` hostnames" — which is the opposite of what `sdk.host.getBridgeAddress` does. Also drops imports left dead by the helper's removal.
MattDHill
approved these changes
Jul 25, 2026
MattDHill
left a comment
MattDHill
left a comment
Member
There was a problem hiding this comment.
Docs-and-dead-code only. Corrects prose that still described the removed local helper — and in places asserted its internals, which the SDK helper does not do.
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.
Why
Follow-up to the
sdk.host.getBridgeAddressadoption, which left this package's docs describing code it no longer has.The prose still referenced the local
bridgeAddresshelper that was deleted, and in several packages went further — asserting that resolution "readsnet.assignedPort" and uses "neveraddressInfohostnames". That is the opposite of whatsdk.host.getBridgeAddressdoes: it resolves the binding's own derived address, which is addressInfo-derived, precisely so it stays correct whichever port field the dependency populates.Leaving that in place would have taught the next reader the pattern the change removed.
What changed
sdk.host.getBridgeAddress, and any description of the old internals corrected.import { sdk }(tscdoes not flag unused imports, which is how these survived) and, in a few packages, animport {} from './utils'left with empty braces.No behaviour change; docs and dead code only.
Verification
tscand prettier clean.