Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): add doc aliases #843

Merged
merged 7 commits into from
Jun 7, 2024
Merged

chore(docs): add doc aliases #843

merged 7 commits into from
Jun 7, 2024

Conversation

zerosnacks
Copy link
Member

@zerosnacks zerosnacks commented Jun 6, 2024

Motivation

Closes #833

Solution

Adds dual Tx <> Transaction doc alias bindings as a non-intrusive way to resolve inconsistent naming: #814 (comment)

Related alloy-core PR: alloy-rs/core#649

PR Checklist

  • Added Tests
  • Added Documentation
  • Breaking changes

crates/network/src/any/builder.rs Outdated Show resolved Hide resolved
crates/consensus/src/signed.rs Show resolved Hide resolved
crates/consensus/src/transaction/eip2930.rs Outdated Show resolved Hide resolved
crates/consensus/src/transaction/eip4844.rs Outdated Show resolved Hide resolved
crates/consensus/src/transaction/envelope.rs Outdated Show resolved Hide resolved
crates/network/src/ethereum/builder.rs Outdated Show resolved Hide resolved
crates/rpc-types-trace/src/common.rs Outdated Show resolved Hide resolved
crates/rpc-types-trace/src/common.rs Outdated Show resolved Hide resolved
@DaniPopes DaniPopes merged commit 0928b92 into main Jun 7, 2024
24 checks passed
@DaniPopes DaniPopes deleted the zerosnacks/docs-alias-tx branch June 7, 2024 01:22
@zerosnacks
Copy link
Member Author

Good catches and thanks for the fixes! @DaniPopes

ben186 pushed a commit to ben186/alloy that referenced this pull request Jul 27, 2024
* add doc aliases

* more aliases

* more aliases

* more types

* more aliases

* add alias

* Apply suggestions from code review

---------

Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(alias) for better intellisense
3 participants