fix: existing doctests not compiling

Author: Miitto

packages/wm/src/common/direction.rs

@@ -17,7 +17,9 @@ impl Direction {
   ///
   /// Example:
   /// ```
-  /// Direction::Left.inverse() // Direction::Right
+  /// # use wm::common::Direction;
+  /// let dir = Direction::Left.inverse();
+  /// assert_eq!(dir, Direction::Right);
   /// ```
   pub fn inverse(&self) -> Direction {
     match self {
@@ -36,7 +38,10 @@ impl FromStr for Direction {
   ///
   /// Example:
   /// ```
-  /// Direction::from_str("left") // Direction::Left
+  /// # use wm::common::Direction;
+  /// # use std::str::FromStr;
+  /// let dir = Direction::from_str("left");
+  /// assert_eq!(dir.unwrap(), Direction::Left);
   /// ```
   fn from_str(unparsed: &str) -> anyhow::Result<Self> {
     match unparsed {

packages/wm/src/common/length_value.rs

@@ -50,7 +50,14 @@ impl FromStr for LengthValue {
   ///
   /// Example:
   /// ```
-  /// LengthValue::from_str("100px") // { amount: 100.0, unit: LengthUnit::Pixel }
+  /// # use wm::common::{LengthValue, LengthUnit};
+  /// # use std::str::FromStr;
+  /// let check = LengthValue {
+  ///   amount: 100.0,
+  ///   unit: LengthUnit::Pixel,
+  /// };
+  /// let parsed = LengthValue::from_str("100px");
+  /// assert_eq!(parsed.unwrap(), check);
   /// ```
   fn from_str(unparsed: &str) -> anyhow::Result<Self> {
     let units_regex = Regex::new(r"([+-]?\d+)(%|px)?")?;

packages/wm/src/common/platform/platform.rs

@@ -337,16 +337,23 @@ impl Platform {
   ///
   /// # Examples
   ///
-  /// ```
-  /// let (prog, args) = parse_command("code .")?;
-  /// assert_eq!(prog, "code");
-  /// assert_eq!(args, ".");
+  /// ```no_run
+  /// # // Since this checks if the path exists, not sure how to test this.
+  /// # // Don't think you can `use` a struct method.
+  /// # use wm::common::platform::Platform;
+  /// fn main() -> anyhow::Result<()> {
+  ///   let (prog, args) = Platform::parse_command("code .")?;
+  ///   assert_eq!(prog, "code");
+  ///   assert_eq!(args, ".");
+  ///
+  ///   let (prog, args) = Platform::parse_command(
+  ///     r#"C:\Program Files\Git\git-bash --cd=C:\Users\larsb\.glaze-wm"#,
+  ///   )?;
+  ///   assert_eq!(prog, r#"C:\Program Files\Git\git-bash"#);
+  ///   assert_eq!(args, r#"--cd=C:\Users\larsb\.glaze-wm"#);
   ///
-  /// let (prog, args) = parse_command(
-  ///   r#"C:\Program Files\Git\git-bash --cd=C:\Users\larsb\.glaze-wm"#,
-  /// )?;
-  /// assert_eq!(prog, r#"C:\Program Files\Git\git-bash"#);
-  /// assert_eq!(args, r#"--cd=C:\Users\larsb\.glaze-wm"#);
+  ///   Ok(())
+  /// }
   /// ```
   pub fn parse_command(command: &str) -> anyhow::Result<(String, String)> {
     // Expand environment variables in the command string.

packages/wm/src/common/tiling_direction.rs

@@ -17,7 +17,9 @@ impl TilingDirection {
   ///
   /// Example:
   /// ```
-  /// TilingDirection::Horizontal.inverse() // TilingDirection::Vertical
+  /// # use wm::common::TilingDirection;
+  /// let dir = TilingDirection::Horizontal.inverse();
+  /// assert_eq!(dir, TilingDirection::Vertical);
   /// ```
   pub fn inverse(&self) -> TilingDirection {
     match self {
@@ -31,7 +33,9 @@ impl TilingDirection {
   ///
   /// Example:
   /// ```
-  /// TilingDirection::from_direction(Direction::Left) // TilingDirection::Horizontal
+  /// # use wm::common::{Direction, TilingDirection};
+  /// let dir = TilingDirection::from_direction(&Direction::Left);
+  /// assert_eq!(dir, TilingDirection::Horizontal);
   /// ```
   pub fn from_direction(direction: &Direction) -> TilingDirection {
     match direction {
@@ -48,7 +52,13 @@ impl FromStr for TilingDirection {
   ///
   /// Example:
   /// ```
-  /// TilingDirection::from_str("horizontal") // TilingDirection::Horizontal
+  /// # use wm::common::TilingDirection;
+  /// # use std::str::FromStr;
+  /// let dir = TilingDirection::from_str("horizontal");
+  /// assert_eq!(dir.unwrap(), TilingDirection::Horizontal);
+  ///
+  /// let dir = TilingDirection::from_str("vertical");
+  /// assert_eq!(dir.unwrap(), TilingDirection::Vertical);
   /// ```
   fn from_str(unparsed: &str) -> anyhow::Result<Self> {
     match unparsed {

packages/wm/src/containers/commands/flatten_child_split_containers.rs

@@ -8,7 +8,7 @@ use crate::containers::{
 /// parent container.
 ///
 /// For example:
-/// ```
+/// ```no_run,compile_fail,ignore
 /// H[1 H[V[2, 3]]] -> H[1, 2, 3]
 /// H[1 H[2, 3]] -> H[1, 2, 3]
 /// H[V[1]] -> V[1]