Repository navigation
docs(helpers): correct broadcast return type and range example - #137
Conversation
[Low impact] No blocking findings; the documentation-only changes are suitable to merge. SummaryCorrects two examples in the helper guide:
Adds a changelog note. No runtime code changes or actionable issues found. The documentation agrees with the public contract and comparison implementation. No blocking issue was identified; this documentation-only change is suitable to merge. T-Rex validation blockedThe broadcast and range examples could not be executed because PHP CLI is unavailable in this environment. Both attempted checks exited 127, and no API return values were observed. Scripts and output logs were preserved locally, but no evidence-upload mechanism was available, so remote upload could not be confirmed. Reviews (1) · Last reviewed commit: "docs(helpers): 📚 correct broadcast cont..." · Reviewed by Greptile |
|
Thank you for the pull request! |
What and why
Two existing helper-guide examples contradict the public API:
getBroadcastIp()is shown as returningbool, but returns a new IP value object (as its example andArithmeticInterfacealready expect).inRange()example supplies:ffff:c22:384e, which has a single leading colon rather than valid IPv6 notation and cannot reach either comparison. Replace the example with RFC 5737 documentation addresses in the same /24, showing both a matching /24 and a non-matching /32.This changes documentation only; no parsing or comparison semantics change. Includes a changelog note.
Validation
php -n, with ctype loaded).git diff --checkpasses.