Skip to content

Commit 66b0710

Browse files
tcoratgerclaude
andauthored
docs(spec): fix duplicated phrasing and filler in lstar docs (leanEthereum#880)
Pure documentation cleanup, no behavior change: - Remove the doubled "single-message single-message" / "single-message aggregate single-message aggregated" phrasing (a bad find/replace) in the aggregate-proof verify docstring and the fork-choice comment. - Drop the "Represents a ..." filler from the Slot, ValidatorIndex, Validator, and Checkpoint summaries; docstring summaries are noun phrases, not "Represents ..." sentences. - Remove the banned backticks around "delta" in the justifiability docstring. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 7dc5d45 commit 66b0710

6 files changed

Lines changed: 7 additions & 7 deletions

File tree

src/lean_spec/spec/forks/lstar/containers/aggregation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ def verify(
132132
slot: Slot,
133133
) -> None:
134134
"""
135-
Verify this single-message single-message aggregate proof against a public_key set.
135+
Verify this single-message aggregate proof against a set of public keys.
136136
137137
Args:
138138
public_keys: PublicKeys for the validators named by participants.

src/lean_spec/spec/forks/lstar/containers/checkpoint.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
class Checkpoint(Container):
1313
"""
14-
Represents a checkpoint in the chain's history.
14+
A checkpoint in the chain's history.
1515
1616
A checkpoint marks a specific moment in the chain.
1717

src/lean_spec/spec/forks/lstar/containers/identifiers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class SubnetId(Uint64):
1010

1111

1212
class ValidatorIndex(Uint64):
13-
"""Represents a validator's unique index as a 64-bit unsigned integer."""
13+
"""A validator's index in the registry, as a 64-bit unsigned integer."""
1414

1515
@classmethod
1616
def proposer_for_slot(cls, slot: Slot, num_validators: Uint64) -> "ValidatorIndex":

src/lean_spec/spec/forks/lstar/containers/validator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77

88
class Validator(Container):
9-
"""Represents a validator's static metadata and operational interface."""
9+
"""A validator's static metadata and operational interface."""
1010

1111
attestation_public_key: Bytes52
1212
"""XMSS public key for signing attestations."""

src/lean_spec/spec/forks/lstar/fork_choice.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ def on_gossip_aggregated_attestation(
394394
for validator_index in validator_indices
395395
]
396396

397-
# Verify the single-message aggregate single-message aggregated proof.
397+
# Verify the single-message aggregate proof.
398398
try:
399399
aggregated_proof.verify(
400400
public_keys=public_keys,

src/lean_spec/spec/forks/lstar/slot.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717

1818
class Slot(Uint64):
19-
"""Represents a slot number as a 64-bit unsigned integer."""
19+
"""A slot number, as a 64-bit unsigned integer."""
2020

2121
def justified_index_after(self, finalized_slot: "Slot") -> int | None:
2222
"""
@@ -36,7 +36,7 @@ def is_justifiable_after(self, finalized_slot: "Slot") -> bool:
3636
Checks if this slot is a valid candidate for justification after a given finalized slot.
3737
3838
According to the 3SF-mini specification, a slot is justifiable if its
39-
distance (`delta`) from the last finalized slot is:
39+
distance (delta) from the last finalized slot is:
4040
1. Less than or equal to 5.
4141
2. A perfect square (e.g., 9, 16, 25...).
4242
3. A pronic number (of the form x^2 + x, e.g., 6, 12, 20...).

0 commit comments

Comments
 (0)