From 7f05d3918193cda037dc7c734b5f3f861b29e4f0 Mon Sep 17 00:00:00 2001
From: Adam Skoufis <askoufis@seek.com.au>
Date: Wed, 11 Dec 2024 13:06:21 +1100
Subject: [PATCH] Clarify implementation in jsdoc

---
 src/Playroom/palettes.ts | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/src/Playroom/palettes.ts b/src/Playroom/palettes.ts
index 427f360b..82dda3b3 100644
--- a/src/Playroom/palettes.ts
+++ b/src/Playroom/palettes.ts
@@ -29,21 +29,30 @@ const guard = (amount: number) => {
 };
 
 /**
- * Implementation of `transparentize` from polished but using native CSS
+ * Subtracts `amount` from the alpha channel of `color`.
+ * Amount must be between 0 and 1 inclusive.
+ *
+ * Similar to `transparentize` from polished but uses CSS
  * @see https://polished.js.org/docs/#transparentize
  */
 const transparentize = (amount: number, color: string) =>
   `rgb(from ${color} r g b / calc(alpha - ${guard(amount)}))`;
 
 /**
- * Implementation of `darken` from polished but using native CSS
+ * Subtracts `amount` from the lightness of `color`.
+ * Amount must be between 0 and 1 inclusive.
+ *
+ * Similar to `darken` from polished but uses CSS
  * @see https://polished.js.org/docs/#darken
  */
 const darken = (amount: number, color: string) =>
   `hsl(from ${color} h s calc(l - ${guard(amount) * 100}))`;
 
 /**
- * Implementation of `mix` from polished but using native CSS
+ * Mixes `amount` of `color1` into `color2`.
+ * Amount must be between 0 and 1 inclusive.
+ *
+ * Similar to `mix` from polished but uses CSS
  * @see https://polished.js.org/docs/#mix
  */
 const mix = (amount: number, color1: string, color2: string) =>