doc: clarify slug_create

Not everyone knows what a "slug" is, let's clarify it a bit and also say where it is used. Signed-off-by: Simon de Vlieger <[email protected]>
supakeen · Jun 25, 2024 · e0b5f2c · e0b5f2c
1 parent 71fd383
commit e0b5f2c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/pinnwand/utility.py b/src/pinnwand/utility.py
@@ -77,7 +77,10 @@ def slug_create(
 ) -> str:
     """Creates a new slug, a slug has to be unique within both the Paste and
     File namespace. These slugs auto-lengthen unless they are specified not
-    to."""
+    to.
+
+    Slugs are unique identifiers that are used the URLs that pinnwand serves
+    pastes and files on."""
 
     if dont_use is None:
         dont_use = []