fixed docstrings to be less confusing

QuietImCoding · QuietImCoding · commit 3921fb517e11 · 2026-02-02T10:00:56.000-08:00
diff --git a/app/utils/colors.ts b/app/utils/colors.ts
@@ -148,14 +148,14 @@ export function lightenOklch(
 }
 
 /**
- * Lighten an OKLCH color by a given factor.
+ * Darken an OKLCH color by a given factor.
  *
  * Works with strict TypeScript settings including `noUncheckedIndexedAccess`,
  * where `match[n]` is typed as `string | undefined`.
  *
  * @param oklch - Color in the form "oklch(L C H)" or "oklch(L C H / A)"
- * @param factor - Lightening force in range [0, 1]
- * @returns Lightened OKLCH color string (0.5 = 50% lighter)
+ * @param factor - Darkening force in range [0, 1]
+ * @returns Darkened OKLCH color string (0.5 = 50% lighter)
  */
 export function darkenOklch(
   oklch: string | null | undefined,

Original file line number	Diff line number	Diff line change
`@@ -148,14 +148,14 @@ export function lightenOklch(`
`148`	`148`	`}`
`149`	`149`
`150`	`150`	`/**`
`151`		`- * Lighten an OKLCH color by a given factor.`
	`151`	`+ * Darken an OKLCH color by a given factor.`
`152`	`152`	`*`
`153`	`153`	* Works with strict TypeScript settings including `noUncheckedIndexedAccess`,
`154`	`154`	* where `match[n]` is typed as `string \| undefined`.
`155`	`155`	`*`
`156`	`156`	`* @param oklch - Color in the form "oklch(L C H)" or "oklch(L C H / A)"`
`157`		`- * @param factor - Lightening force in range [0, 1]`
`158`		`- * @returns Lightened OKLCH color string (0.5 = 50% lighter)`
	`157`	`+ * @param factor - Darkening force in range [0, 1]`
	`158`	`+ * @returns Darkened OKLCH color string (0.5 = 50% lighter)`
`159`	`159`	`*/`
`160`	`160`	`export function darkenOklch(`
`161`	`161`	`oklch: string \| null \| undefined,`