From 3d5c20863cd895a337c3b08345d1ab0c4cff966f Mon Sep 17 00:00:00 2001
From: LB Johnston <mail@lb.ee>
Date: Wed, 2 Oct 2024 13:29:30 +1000
Subject: [PATCH] Clean up JSDoc on Slugify
- Ensure it's added directly above the function
- Update the description to match the options
---
client/src/utils/slugify.ts | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/client/src/utils/slugify.ts b/client/src/utils/slugify.ts
index d0446a55a4..a509232cc5 100644
--- a/client/src/utils/slugify.ts
+++ b/client/src/utils/slugify.ts
@@ -1,9 +1,8 @@
/**
- * Returns the supplied string as a slug, accepts options.unicodeSlugsEnabled to support
+ * Returns the supplied string as a slug, accepts options.allowUnicode to support
* additional characters being allowed.
- * special characters of other languages which are not validated by django's slug validator are discarded.
+ * Special characters of other languages which are not validated by django's slug validator are discarded.
*/
-
export const slugify = (
value: string,
{ allowUnicode = false }: { allowUnicode?: boolean } = {},