Skip to content

docs(consensus): clarify generic EIP-4844 return doc - #3997

Merged
onbjerg merged 1 commit into
alloy-rs:mainfrom
jschnelder:consensus-clarify-eip4844-return-doc
Sep 9, 2026
Merged

onbjerg merged 1 commit into
alloy-rs:mainfrom
jschnelder:consensus-clarify-eip4844-return-doc

Conversation

@jschnelder

Copy link
Copy Markdown
Contributor

Motivation

The doc comment for try_into_eip4844 in crates/consensus/src/transaction/envelope.rs was too specific and implied the return was tied to TxEip4844, while the actual signature is generic (Result<Signed<Eip4844>, ValueError<Self>>).
This mismatch can confuse readers about the API contract.

Solution

Updated the doc comment to describe the return as the EIP-4844 variant in generic terms, matching the method signature and avoiding type-specific wording.
This is a docs-only change with no runtime behavior change.

PR Checklist

  • Added Tests (docs-only change)
  • Added Documentation
  • Breaking changes

@github-project-automation github-project-automation Bot moved this to Reviewed in Alloy Sep 9, 2026
@onbjerg
onbjerg force-pushed the consensus-clarify-eip4844-return-doc branch from c812e90 to 47df58a Compare September 9, 2026 08:27
@onbjerg
onbjerg enabled auto-merge (squash) September 9, 2026 08:28
@onbjerg
onbjerg merged commit 649b1bd into alloy-rs:main Sep 9, 2026
30 checks passed
@github-project-automation github-project-automation Bot moved this from Reviewed to Done in Alloy Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants