docs(clock): trim verbose gossip-disparity doc comments#9631
Open
lodekeeper wants to merge 1 commit into
Open
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}
Contributor
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
reviewed
Jul 9, 2026
nflaig
left a comment
nflaig
left a comment
Member
There was a problem hiding this comment.
@spiral-ladder do you like this more?
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
4 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
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.