docs(fork-choice): trim drifted numbered overviews in docstrings - #1142
Merged
tcoratger merged 1 commit intoJun 17, 2026
Merged
Conversation
Two docstrings carried numbered overview lists that duplicated the method bodies' own labeled section comments and had drifted out of sync. The attestation validation docstring listed seven checks while the body has six labeled sections. The block-processing docstring listed four steps but omitted the duplicate-data rejection and signature verification the body performs. Trim each numbered list to a single accurate summary line. The labeled body comments remain the source of truth. Docs-only change. just check passes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
Two docstrings in the lstar fork-choice module carried numbered overview lists that duplicated the method bodies' own labeled section comments, and both had drifted out of sync with the code.
Each numbered list is trimmed to a single accurate summary line. The labeled in-body comments remain the source of truth, per the doc rule that bans an algorithm recap in the docstring when the body already has labeled phase comments.
Why
Numbered overviews that mirror the body decay independently of it. Both lists had already drifted in count and content, so they now misinform rather than guide.
Docs-only change. No behavior change.
just checkpasses.🤖 Generated with Claude Code