revise docs

crates/kira/src/clock.rs

@@ -26,8 +26,8 @@ Clocks are stopped when you first create them, so be sure to explicitly call
 
 Sounds can be set to only start playing when a clock has ticked a certain
 number of times. You can configure this using
-[`StaticSoundSettings::start_time`](crate::sound::static_sound::StaticSoundSettings::start_time)
-or [`StreamingSoundSettings::start_time`](crate::sound::streaming::StreamingSoundSettings::start_time).
+[`StaticSoundData::start_time`](crate::sound::static_sound::StaticSoundData::start_time)
+or [`StreamingSoundData::start_time`](crate::sound::streaming::StreamingSoundData::start_time).
 
 ```no_run
 use kira::{

crates/kira/src/effect.rs

@@ -32,7 +32,7 @@ pub trait EffectBuilder {
 
 /// Receives input audio from a mixer track and outputs modified audio.
 ///
-/// For performance reasons, avoid allocating and deallocating in any methods
+/// For performance reasons, avoid allocating and deallocating memory in any methods
 /// of this trait besides [`on_change_sample_rate`](Effect::on_change_sample_rate).
 #[allow(unused_variables)]
 pub trait Effect: Send {

crates/kira/src/effect/compressor/builder.rs

@@ -30,9 +30,7 @@ pub struct CompressorBuilder {
 	/// dry signal.
 	pub makeup_gain: Value<Decibels>,
 	/// How much dry (unprocessed) signal should be blended
-	/// with the wet (processed) signal. `0.0` means
-	/// only the dry signal will be heard. `1.0` means
-	/// only the wet signal will be heard.
+	/// with the wet (processed) signal.
 	pub mix: Value<Mix>,
 }
 
@@ -113,9 +111,7 @@ impl CompressorBuilder {
 	}
 
 	/// Sets how much dry (unprocessed) signal should be blended
-	/// with the wet (processed) signal. `0.0` means
-	/// only the dry signal will be heard. `1.0` means
-	/// only the wet signal will be heard.
+	/// with the wet (processed) signal.
 	#[must_use = "This method consumes self and returns a modified CompressorBuilder, so the return value should be used"]
 	pub fn mix(self, mix: impl Into<Value<Mix>>) -> Self {
 		Self {

crates/kira/src/effect/compressor/handle.rs

@@ -38,9 +38,7 @@ impl CompressorHandle {
 		makeup_gain: Decibels,
 
 		/// Sets how much dry (unprocessed) signal should be blended
-		/// with the wet (processed) signal. `0.0` means only the dry
-		/// signal will be heard. `1.0` means only the wet signal will
-		/// be heard.
+		/// with the wet (processed) signal.
 		mix: Mix,
 	}
 }

crates/kira/src/effect/delay/builder.rs

@@ -16,9 +16,7 @@ pub struct DelayBuilder {
 	/// Effects that should be applied in the feedback loop.
 	pub(super) feedback_effects: Vec<Box<dyn Effect>>,
 	/// How much dry (unprocessed) signal should be blended
-	/// with the wet (processed) signal. `0.0` means
-	/// only the dry signal will be heard. `1.0` means
-	/// only the wet signal will be heard.
+	/// with the wet (processed) signal.
 	pub(super) mix: Value<Mix>,
 }
 

crates/kira/src/effect/delay/handle.rs

@@ -14,9 +14,7 @@ impl DelayHandle {
 		feedback: Decibels,
 
 		/// Sets how much dry (unprocessed) signal should be blended
-		/// with the wet (processed) signal. `0.0` means only the dry
-		/// signal will be heard. `1.0` means only the wet signal will
-		/// be heard.
+		/// with the wet (processed) signal.
 		mix: Mix,
 	}
 }

crates/kira/src/effect/distortion/builder.rs

@@ -14,9 +14,7 @@ pub struct DistortionBuilder {
 	/// the distortion.
 	pub drive: Value<Decibels>,
 	/// How much dry (unprocessed) signal should be blended
-	/// with the wet (processed) signal. `0.0` means
-	/// only the dry signal will be heard. `1.0` means
-	/// only the wet signal will be heard.
+	/// with the wet (processed) signal.
 	pub mix: Value<Mix>,
 }
 

crates/kira/src/effect/distortion/handle.rs

@@ -19,9 +19,7 @@ impl DistortionHandle {
 		drive: Decibels,
 
 		/// Sets how much dry (unprocessed) signal should be blended
-		/// with the wet (processed) signal. `0.0` means only the dry
-		/// signal will be heard. `1.0` means only the wet signal will
-		/// be heard.
+		/// with the wet (processed) signal.
 		mix: Mix,
 	}
 }

crates/kira/src/effect/filter/builder.rs

@@ -18,9 +18,7 @@ pub struct FilterBuilder {
 	/// a distinctive "ringing" sound.
 	pub resonance: Value<f64>,
 	/// How much dry (unprocessed) signal should be blended
-	/// with the wet (processed) signal. `0.0` means
-	/// only the dry signal will be heard. `1.0` means
-	/// only the wet signal will be heard.
+	/// with the wet (processed) signal.
 	pub mix: Value<Mix>,
 }
 

crates/kira/src/effect/filter/handle.rs

@@ -22,9 +22,7 @@ impl FilterHandle {
 		resonance: f64,
 
 		/// Sets how much dry (unprocessed) signal should be blended
-		/// with the wet (processed) signal. `0.0` means only the dry
-		/// signal will be heard. `1.0` means only the wet signal will
-		/// be heard.
+		/// with the wet (processed) signal.
 		mix: Mix,
 	}
 }

crates/kira/src/effect/reverb/builder.rs

@@ -18,9 +18,7 @@ pub struct ReverbBuilder {
 	/// 1.0 being fully stereo).
 	pub stereo_width: Value<f64>,
 	/// How much dry (unprocessed) signal should be blended
-	/// with the wet (processed) signal. `0.0` means
-	/// only the dry signal will be heard. `1.0` means
-	/// only the wet signal will be heard.
+	/// with the wet (processed) signal.
 	pub mix: Value<Mix>,
 }
 

crates/kira/src/effect/reverb/handle.rs

@@ -23,9 +23,7 @@ impl ReverbHandle {
 		stereo_width: f64,
 
 		/// Sets how much dry (unprocessed) signal should be blended
-		/// with the wet (processed) signal. `0.0` means only the dry
-		/// signal will be heard. `1.0` means only the wet signal will
-		/// be heard.
+		/// with the wet (processed) signal.
 		mix: Mix,
 	}
 }

crates/kira/src/lib.rs

@@ -4,7 +4,7 @@
 Kira is a backend-agnostic library to create expressive audio for games. It provides
 tweens for smoothly adjusting properties of sounds, a flexible [mixer](track)
 for applying [effects](effect) to audio, a [clock] system for precisely timing audio events,
-and [spatial audio](listener) support.
+and [spatial audio](crate::track#spatial-tracks) support.
 
 To get started, create an [`AudioManager`] and use it to [play](AudioManager::play) a
 [`StaticSoundData`](crate::sound::static_sound::StaticSoundData) or