Skip to content

Commit

Permalink
include pool in docrs
Browse files Browse the repository at this point in the history
fix StreamCommands doc
  • Loading branch information
mcatanzariti committed Dec 2, 2022
1 parent a74bdbf commit b3da3af
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 1 deletion.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,7 @@ serial_test = "0"
tokio = { version = "1", features = ["rt-multi-thread"] }
rand = "0.8.4"
env_logger = "0"

[package.metadata.docs.rs]
features = ["tokio-runtime", "tokio-tls", "redis-stack", "pool"]
rustdoc-args = ["--cfg", "docsrs"]
2 changes: 2 additions & 0 deletions src/clients/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ mod inner_client;
mod message;
mod monitor_stream;
mod multiplexed_client;
#[cfg_attr(docsrs, doc(cfg(feature = "pool")))]
#[cfg(feature = "pool")]
mod pooled_client_manager;
mod pipeline;
Expand All @@ -21,6 +22,7 @@ pub(crate) use message::*;
pub use monitor_stream::*;
pub use multiplexed_client::*;
pub use pipeline::*;
#[cfg_attr(docsrs, doc(cfg(feature = "pool")))]
#[cfg(feature = "pool")]
pub use pooled_client_manager::*;
pub use pub_sub_stream::*;
Expand Down
2 changes: 1 addition & 1 deletion src/commands/stream_commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ pub trait StreamCommands {
prepare_command(self, cmd("XDEL").arg(key).arg(ids))
}

/// This command creates a new consumer group uniquely identified by <groupname> for the stream stored at <key>.
/// This command creates a new consumer group uniquely identified by `groupname` for the stream stored at `key`.
///
/// # Return
/// * `true` success
Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![cfg_attr(docsrs, feature(doc_cfg))]
//! A Redis client for Rust
mod clients;
Expand Down

0 comments on commit b3da3af

Please sign in to comment.