chore: trim verbose gossip-disparity doc comments - #9631
Conversation
Trim the over-explained `<=` / strict-`<` gossip-disparity doc comments on `currentSlotWithGossipDisparity` and `isCurrentSlotGivenGossipDisparity` down to the essential spec reference. Flagged during the lodestar-z clock port (ChainSafe/lodestar-z#463), where they were ported verbatim and read as noise. No code change. 🤖 Generated with AI assistance Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request simplifies the JSDoc comments in packages/beacon-node/src/util/clock.ts regarding the gossip clock disparity and spec references, making them more concise. There are no review comments, so I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
nflaig
left a comment
nflaig
left a comment
There was a problem hiding this comment.
@spiral-ladder do you like this more?
|
@spiral-ladder what are we doing with this one? |
nflaig
changed the title
|
Missed ur mention, looks good |
|
🎉 This PR is included in v1.46.0 🎉 |
6 participants
Summary
Trims two over-explained gossip-disparity doc comments in
packages/beacon-node/src/util/clock.tsdown to the essential spec reference:Clock.currentSlotWithGossipDisparitygetterClock.isCurrentSlotGivenGossipDisparityBoth restated the
<=vs strict-<boundary at length. The trimmed form keeps the spec pointer (phase0/p2p-interface.mdrejects future messages with strict<, hence<=) and drops the redundant re-explanation.Motivation
These comments were ported verbatim into the lodestar-z Zig clock (ChainSafe/lodestar-z#463), where reviewers flagged them as verbose/noisy. Trimming the TS source keeps future ports lean.
Comment-only change — no behavior change.