docs: clean up top level docs (#2028)

alloy-rs · Feb 7, 2025 · ef23dae · ef23dae
1 parent 6677ce8
commit ef23dae
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 20 deletions.
diff --git a/crates/eip5792/README.md b/crates/eip5792/README.md
@@ -1,3 +1,11 @@
 # alloy-eip5792
 
-types for [EIP-5792](https://eips.ethereum.org/EIPS/eip-5792)
+Types for the Wallet Call API.
+
+- `wallet_getCapabilities` based on [EIP-5792][eip-5792], with the only capability being
+  `delegation`.
+- `wallet_sendTransaction` that can perform sequencer-sponsored [EIP-7702][eip-7702] delegations
+  and send other sequencer-sponsored transactions on behalf of EOAs with delegated code.
+
+[eip-5792]: https://eips.ethereum.org/EIPS/eip-5792
+[eip-7702]: https://eips.ethereum.org/EIPS/eip-7702
diff --git a/crates/eip5792/src/lib.rs b/crates/eip5792/src/lib.rs
@@ -1,13 +1,4 @@
 #![doc = include_str!("../README.md")]
-//! Types for the Wallet Call API.
-//!
-//! - `wallet_getCapabilities` based on [EIP-5792][eip-5792], with the only capability being
-//!   `delegation`.
-//! - `wallet_sendTransaction` that can perform sequencer-sponsored [EIP-7702][eip-7702] delegations
-//!   and send other sequencer-sponsored transactions on behalf of EOAs with delegated code.
-//!
-//! [eip-5792]: https://eips.ethereum.org/EIPS/eip-5792
-//! [eip-7702]: https://eips.ethereum.org/EIPS/eip-7702
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg",
     html_favicon_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/favicon.ico"

diff --git a/crates/rpc-types-trace/src/lib.rs b/crates/rpc-types-trace/src/lib.rs
@@ -3,14 +3,6 @@
     html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg",
     html_favicon_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/favicon.ico"
 )]
-#![warn(
-    missing_copy_implementations,
-    missing_debug_implementations,
-    missing_docs,
-    unreachable_pub,
-    clippy::missing_const_for_fn,
-    rustdoc::all
-)]
 #![cfg_attr(not(test), warn(unused_crate_dependencies))]
 #![deny(unused_must_use, rust_2018_idioms)]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

diff --git a/crates/serde/src/lib.rs b/crates/serde/src/lib.rs
@@ -1,5 +1,3 @@
-//! Alloy serde helpers for primitive types.
-
 #![doc = include_str!("../README.md")]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg",