Skip to content

Commit 8e0c230

Browse files
committed
Align note comments to use complete sentences
1 parent 9bf115f commit 8e0c230

6 files changed

Lines changed: 8 additions & 11 deletions

File tree

specs/bellatrix/fork-choice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ EIP-3675, before a post-transition block is finalized,
8181
`finalized_block_hash = Hash32()`.
8282

8383
*Note*: Client software MUST NOT call this function until the transition
84-
conditions are met on the PoW network, i.e. there exists a block for which
84+
conditions are met on the PoW network, i.e. there exists a block for which the
8585
`is_valid_terminal_pow_block` function returns `True`.
8686

8787
*Note*: Client software MUST call this function to initiate the payload build

specs/bellatrix/validator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ avoid requiring simple serialize hashing capabilities in the execution layer.
8787

8888
### `ExecutionEngine`
8989

90-
*Note*: `get_payload` function is added to the `ExecutionEngine` protocol for
91-
use as a validator.
90+
*Note*: The `get_payload` function is added to the `ExecutionEngine` protocol
91+
for use as a validator.
9292

9393
The body of this function is implementation dependent. The Engine API may be
9494
used to implement it with an external execution engine.

specs/capella/validator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class GetPayloadResponse:
5353

5454
#### Modified `get_payload`
5555

56-
`get_payload` returns the upgraded Capella `ExecutionPayload` type.
56+
`get_payload` returns the updated `GetPayloadResponse` object.
5757

5858
## Beacon chain responsibilities
5959

specs/electra/validator.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,7 @@ class SignedAggregateAndProof(Container):
8888

8989
#### Modified `get_payload`
9090

91-
Given the `payload_id`, `get_payload` returns the most recent version of the
92-
execution payload that has been built since the corresponding call to
93-
`notify_forkchoice_updated` method.
91+
`get_payload` returns the updated `GetPayloadResponse` object.
9492

9593
```python
9694
def get_payload(self: ExecutionEngine, payload_id: PayloadId) -> GetPayloadResponse:

specs/fulu/validator.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,7 @@ class GetPayloadResponse:
9191

9292
#### Modified `get_payload`
9393

94-
The `get_payload` method is modified to return the updated `GetPayloadResponse`
95-
object.
94+
`get_payload` returns the updated `GetPayloadResponse` object.
9695

9796
```python
9897
def get_payload(self: ExecutionEngine, payload_id: PayloadId) -> GetPayloadResponse:

specs/heze/validator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ class GetInclusionListResponse:
4444

4545
### `ExecutionEngine`
4646

47-
*Note*: `get_inclusion_list` function is added to the `ExecutionEngine` protocol
48-
for use as an inclusion list committee member.
47+
*Note*: The `get_inclusion_list` function is added to the `ExecutionEngine`
48+
protocol for use as an inclusion list committee member.
4949

5050
The body of this function is implementation dependent. The Engine API may be
5151
used to implement it with an external execution engine.

0 commit comments

Comments
 (0)