From f2b039d972cc472581f99b50bc9c879b2689b664 Mon Sep 17 00:00:00 2001 From: Travis Gockel Date: Wed, 9 Apr 2025 13:42:40 -0600 Subject: [PATCH] Remove use of `doc(cfg(...))` and the docsrs configuration The documentation build for the crate on docs.rs has been failing with an error that `doc(cfg(...))` is an experimental feature. Instead of fixing this, this changeset removes the only use of the feature from the `GenericTcpStream` enumeration, which is internal and does not show in documentation anyway. --- Cargo.toml | 1 - src/client/mod.rs | 1 - src/lib.rs | 2 -- 3 files changed, 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index eece26e9..073667c6 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,6 @@ categories = ["network-programming"] readme = "README.md" [package.metadata."docs.rs"] -rustdoc-args = ["--cfg", "docsrs"] all-features = true [workspace] diff --git a/src/client/mod.rs b/src/client/mod.rs index 4807ae7d..42849701 100644 --- a/src/client/mod.rs +++ b/src/client/mod.rs @@ -84,7 +84,6 @@ mod metrics; mod options; mod task; -#[cfg_attr(docsrs, doc(cfg(feature = "tokio-stream")))] #[pin_project(project = StreamProj)] #[derive(Debug)] pub enum GenericTcpStream { diff --git a/src/lib.rs b/src/lib.rs index e460fd37..d6633b00 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -71,8 +71,6 @@ //! ``` //! For more consumer options check [`ConsumerBuilder`] -#![cfg_attr(docsrs, feature(doc_cfg))] - mod byte_capacity; mod client; mod consumer;