Skip to content

Commit b24b243

Browse files
committed
fix: conditionally compile doctests requiring SSL features
1 parent 6fb8acd commit b24b243

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

crates/electrum/src/bdk_electrum_client.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ impl<E: ElectrumApi> BdkElectrumClient<E> {
3131
///
3232
/// # Example
3333
///
34-
/// ```no_run
34+
#[cfg_attr(not(any(feature = "use-rustls", feature = "use-rustls-ring", feature = "use-openssl")), doc = "```ignore")]
35+
#[cfg_attr(any(feature = "use-rustls", feature = "use-rustls-ring", feature = "use-openssl"), doc = "```no_run")]
3536
/// use bdk_electrum::{electrum_client, BdkElectrumClient};
3637
///
3738
/// let client = electrum_client::Client::new("ssl://electrum.blockstream.info:50002")?;
@@ -102,7 +103,8 @@ impl<E: ElectrumApi> BdkElectrumClient<E> {
102103
///
103104
/// # Example
104105
///
105-
/// ```no_run
106+
#[cfg_attr(not(any(feature = "use-rustls", feature = "use-rustls-ring", feature = "use-openssl")), doc = "```ignore")]
107+
#[cfg_attr(any(feature = "use-rustls", feature = "use-rustls-ring", feature = "use-openssl"), doc = "```no_run")]
106108
/// use bdk_core::{spk_client::FullScanRequest, BlockId, CheckPoint};
107109
/// use bdk_electrum::BdkElectrumClient;
108110
/// # use bdk_electrum::electrum_client;
@@ -206,7 +208,8 @@ impl<E: ElectrumApi> BdkElectrumClient<E> {
206208
///
207209
/// # Example
208210
///
209-
/// ```no_run
211+
#[cfg_attr(not(any(feature = "use-rustls", feature = "use-rustls-ring", feature = "use-openssl")), doc = "```ignore")]
212+
#[cfg_attr(any(feature = "use-rustls", feature = "use-rustls-ring", feature = "use-openssl"), doc = "```no_run")]
210213
/// use bdk_core::bitcoin::ScriptBuf;
211214
/// use bdk_core::spk_client::SyncRequest;
212215
/// use bdk_electrum::BdkElectrumClient;

0 commit comments

Comments
 (0)