Skip to content

Commit ca668a4

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

7 files changed

Lines changed: 31 additions & 24 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: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,22 +87,23 @@ 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.
9595

9696
#### `get_payload`
9797

98-
Given the `payload_id`, `get_payload` returns `GetPayloadResponse` with the most
99-
recent version of the execution payload that has been built since the
100-
corresponding call to `notify_forkchoice_updated` method.
98+
*Note*: Given the `payload_id`, the `get_payload` function returns
99+
`GetPayloadResponse` with the most recent version of the execution payload that
100+
has been built since the corresponding call to `notify_forkchoice_updated`
101+
method.
101102

102103
```python
103104
def get_payload(self: ExecutionEngine, payload_id: PayloadId) -> GetPayloadResponse:
104105
"""
105-
Return ``GetPayloadResponse`` object.
106+
Return ExecutionPayload object.
106107
"""
107108
```
108109

specs/capella/validator.md

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

5454
#### Modified `get_payload`
5555

56-
`get_payload` returns the upgraded Capella `ExecutionPayload` type.
56+
*Note*: The `get_payload` function returns the updated `GetPayloadResponse`
57+
object.
58+
59+
```python
60+
def get_payload(self: ExecutionEngine, payload_id: PayloadId) -> GetPayloadResponse:
61+
"""
62+
Return ExecutionPayload, and uint256 objects.
63+
"""
64+
```
5765

5866
## Beacon chain responsibilities
5967

specs/deneb/validator.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,13 @@ def compute_signed_block_header(signed_block: SignedBeaconBlock) -> SignedBeacon
8181

8282
#### Modified `get_payload`
8383

84-
Given the `payload_id`, `get_payload` returns the most recent version of the
85-
execution payload that has been built since the corresponding call to
86-
`notify_forkchoice_updated` method.
84+
*Note*: The `get_payload` function returns the updated `GetPayloadResponse`
85+
object.
8786

8887
```python
8988
def get_payload(self: ExecutionEngine, payload_id: PayloadId) -> GetPayloadResponse:
9089
"""
91-
Return ExecutionPayload, uint256, BlobsBundle objects.
90+
Return ExecutionPayload, uint256, and BlobsBundle objects.
9291
"""
9392
```
9493

specs/electra/validator.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,13 @@ 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+
*Note*: The `get_payload` function returns the updated `GetPayloadResponse`
92+
object.
9493

9594
```python
9695
def get_payload(self: ExecutionEngine, payload_id: PayloadId) -> GetPayloadResponse:
9796
"""
98-
Return ExecutionPayload, uint256, BlobsBundle and execution requests (as Sequence[bytes]) objects.
97+
Return ExecutionPayload, uint256, BlobsBundle, and execution requests (as Sequence[bytes]) objects.
9998
"""
10099
```
101100

specs/fulu/validator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ class GetPayloadResponse:
9191

9292
#### Modified `get_payload`
9393

94-
The `get_payload` method is modified to return the updated `GetPayloadResponse`
94+
*Note*: The `get_payload` function returns the updated `GetPayloadResponse`
9595
object.
9696

9797
```python
9898
def get_payload(self: ExecutionEngine, payload_id: PayloadId) -> GetPayloadResponse:
9999
"""
100-
Return ExecutionPayload, uint256, BlobsBundle objects.
100+
Return ExecutionPayload, uint256, BlobsBundle, and execution requests (as Sequence[bytes]) objects.
101101
"""
102102
```
103103

specs/heze/validator.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,22 +44,22 @@ 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.
5252

5353
#### New `get_inclusion_list`
5454

55-
`get_inclusion_list` returns `GetInclusionListResponse` with the most recent
56-
inclusion list transactions that has been built based on the latest view of the
57-
public mempool.
55+
*Note*: `get_inclusion_list` returns `GetInclusionListResponse` with the most
56+
recent inclusion list transactions that has been built based on the latest view
57+
of the public mempool.
5858

5959
```python
6060
def get_inclusion_list(self: ExecutionEngine) -> GetInclusionListResponse:
6161
"""
62-
Return ``GetInclusionListResponse`` object.
62+
Return inclusion list transactions (as Sequence[Transaction]) object.
6363
"""
6464
```
6565

0 commit comments

Comments
 (0)