Skip to content

docs: fix build with unstable features #849

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.

Sign up for GitHub

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

Merged
yara-blue merged 1 commit into from
Feb 22, 2026
+2 −14
Merged

docs: fix build with unstable features #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ lewton = ["dep:lewton"] # Ogg Vorbis
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
cargo-args = ["-Zunstable-options"]

[dependencies]
cpal = { version = "0.17", optional = true }
Expand Down
4 changes: 1 addition & 3 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
allow(unused_variables),
allow(unreachable_code)
)]
#![cfg_attr(docsrs, feature(doc_cfg))]

#[cfg(feature = "playback")]
pub use cpal::{
Expand All @@ -195,7 +196,6 @@ pub mod speakers;
#[cfg(feature = "playback")]
pub mod stream;
#[cfg(feature = "wav_output")]
#[cfg_attr(docsrs, doc(cfg(feature = "wav_output")))]
mod wav_output;

pub mod buffer;
Expand All @@ -222,8 +222,6 @@ pub use crate::spatial_player::SpatialPlayer;
#[cfg(feature = "playback")]
pub use crate::stream::{play, DeviceSinkBuilder, DeviceSinkError, MixerDeviceSink, PlayError};
#[cfg(feature = "wav_output")]
#[cfg_attr(docsrs, doc(cfg(feature = "wav_output")))]
pub use crate::wav_output::wav_to_file;
#[cfg(feature = "wav_output")]
#[cfg_attr(docsrs, doc(cfg(feature = "wav_output")))]
pub use crate::wav_output::wav_to_writer;
5 changes: 0 additions & 5 deletions src/source/agc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,6 @@ where
}

#[cfg(feature = "experimental")]
#[cfg_attr(docsrs, doc(cfg(feature = "experimental")))]
/// Access the target output level for real-time adjustment.
///
/// Use this to dynamically modify the AGC's target level while audio is processing.
Expand All @@ -295,7 +294,6 @@ where
}

#[cfg(feature = "experimental")]
#[cfg_attr(docsrs, doc(cfg(feature = "experimental")))]
/// Access the maximum gain limit for real-time adjustment.
///
/// Use this to dynamically modify the AGC's maximum allowable gain during runtime.
Expand All @@ -306,7 +304,6 @@ where
}

#[cfg(feature = "experimental")]
#[cfg_attr(docsrs, doc(cfg(feature = "experimental")))]
/// Access the attack coefficient for real-time adjustment.
///
/// Use this to dynamically modify how quickly the AGC responds to level increases.
Expand All @@ -318,7 +315,6 @@ where
}

#[cfg(feature = "experimental")]
#[cfg_attr(docsrs, doc(cfg(feature = "experimental")))]
/// Access the release coefficient for real-time adjustment.
///
/// Use this to dynamically modify how quickly the AGC responds to level decreases.
Expand All @@ -330,7 +326,6 @@ where
}

#[cfg(feature = "experimental")]
#[cfg_attr(docsrs, doc(cfg(feature = "experimental")))]
/// Access the AGC on/off control.
/// Use this to dynamically enable or disable AGC processing during runtime.
///
Expand Down
6 changes: 0 additions & 6 deletions src/source/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,13 @@ mod uniform;
mod zero;

#[cfg(feature = "dither")]
#[cfg_attr(docsrs, doc(cfg(feature = "dither")))]
pub mod dither;
#[cfg(feature = "dither")]
#[cfg_attr(docsrs, doc(cfg(feature = "dither")))]
pub use self::dither::{Algorithm as DitherAlgorithm, Dither};

#[cfg(feature = "noise")]
#[cfg_attr(docsrs, doc(cfg(feature = "noise")))]
pub mod noise;
#[cfg(feature = "noise")]
#[cfg_attr(docsrs, doc(cfg(feature = "noise")))]
pub use self::noise::{Pink, WhiteUniform};

/// A source of samples.
Expand Down Expand Up @@ -229,7 +225,6 @@ pub trait Source: Iterator<Item = Sample> {
/// .dither(BitDepth::new(16).unwrap(), DitherAlgorithm::default());
/// ```
#[cfg(feature = "dither")]
#[cfg_attr(docsrs, doc(cfg(feature = "dither")))]
#[inline]
fn dither(self, target_bits: BitDepth, algorithm: DitherAlgorithm) -> Dither<Self>
where
Expand Down Expand Up @@ -764,7 +759,6 @@ pub enum SeekError {
#[error("Symphonia decoder returned an error")]
SymphoniaDecoder(#[source] crate::decoder::symphonia::SeekError),
#[cfg(feature = "hound")]
#[cfg_attr(docsrs, doc(cfg(feature = "hound")))]
/// The hound (wav) decoder ran into an issue
#[error("Hound decoder returned an error")]
HoundDecoder(#[source] Arc<std::io::Error>),
Expand Down