chore:fix typos in examples and ci, format in Cargo.toml and add documents

Author: Decodetalkers

.github/actions/determine-msrv/action.yml

@@ -32,7 +32,7 @@ runs:
         PLATFORM_MSRV="${{ inputs.platform-msrv }}"
         JACK_MSRV="${{ inputs.jack-msrv }}"
         PULSEAUDIO_MSRV="${{ inputs.pulseaudio-msrv }}"
-        PIPEWIRE_MSRV="${{ inputs.pulseaudio-msrv }}"
+        PIPEWIRE_MSRV="${{ inputs.pipewire-msrv }}"
         # Use sort -V to find the maximum version
         VERSIONS="$PLATFORM_MSRV $JACK_MSRV"
         if [ -n "$PULSEAUDIO_MSRV" ]; then

Cargo.toml

@@ -31,6 +31,11 @@ pulseaudio = ["dep:pulseaudio", "dep:futures"]
 # Platform: Linux, DragonFly BSD, FreeBSD, NetBSD, macOS, Windows
 # Note: JACK must be installed separately on all platforms
 jack = ["dep:jack"]
+
+# PipeWire backend
+# Provides audio I/O on Linux and some BSDs via the PipeWire multimedia server
+# Requires: PipeWire server and client libraries installed on the system
+# Platform: Linux, DragonFly BSD, FreeBSD, NetBSD
 pipewire = ["dep:pipewire"]
 
 # Audio thread priority elevation
@@ -104,7 +109,7 @@ audio_thread_priority = { version = "0.34", optional = true }
 jack = { version = "0.13", optional = true }
 pulseaudio = { version = "0.3", optional = true }
 futures = { version = "0.3", optional = true }
-pipewire = { version = "0.9", optional = true, features = ["v0_3_49"]}
+pipewire = { version = "0.9", optional = true, features = ["v0_3_49"] }
 
 [target.'cfg(target_vendor = "apple")'.dependencies]
 mach2 = "0.5"

examples/beep.rs

@@ -32,7 +32,7 @@ struct Opt {
     #[arg(long, default_value_t = false)]
     pulseaudio: bool,
 
-    /// Use the pipewire host. Requires `--feature pipewire`
+    /// Use the Pipewire host. Requires `--features pipewire`
     #[arg(long, default_value_t = false)]
     pipewire: bool,
 }

examples/record_wav.rs

@@ -28,7 +28,7 @@ struct Opt {
     #[arg(long, default_value_t = false)]
     pulseaudio: bool,
 
-    /// Use the pipewire host. Requires `--feature pipewire`
+    /// Use the Pipewire host. Requires `--features pipewire`
     #[arg(long, default_value_t = false)]
     pipewire: bool,
 }