Example code docs test

OmegaTools · Mar 15, 2024 · 239187d · 239187d
1 parent bb2564b
commit 239187d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/Source/HSL/CMYK.ts b/Source/HSL/CMYK.ts
@@ -36,6 +36,16 @@ function toHSL (
 /**
  *  Converts CMYK(A) color arrays to HSL(A) color arrays.
  *
+ *  ### Example
+ *
+ *  ```typescript
+ *  const cmyk = [ 0 , 100 , 100 , 0 ] // Red
+ *
+ *  const hsl = cmykToHSL(cmyk)
+ *
+ *  console.debug(hsl) // [ 0 , 100 , 50 ]
+ *  ```
+ *
  *  @param channels [ Cyan , Magenta , Yellow , Key , ( Alpha ) ]
  *  @returns [ Hue , Saturation , Lightness , ( Alpha ) ]
  */