From fa31a7e279c3083b262237bfc88e125e110cd680 Mon Sep 17 00:00:00 2001
From: Lukas Winkler <derwinlu+git@gmail.com>
Date: Thu, 25 Nov 2021 20:19:33 +0100
Subject: [PATCH] Extend docstring

We want to hint at the location of our default set of substitutions.
This should allow easier reuse for plugin authors who need to access
this utility as well.

Closes #2845
---
 pelican/utils.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pelican/utils.py b/pelican/utils.py
index 4d025657..17667078 100644
--- a/pelican/utils.py
+++ b/pelican/utils.py
@@ -230,6 +230,9 @@ def slugify(value, regex_subs=(), preserve_case=False, use_unicode=False):
     and converts spaces to hyphens.
 
     Took from Django sources.
+
+    For a set of sensible default regex substitutions to pass to regex_subs
+    look into pelican.settings.DEFAULT_CONFIG['SLUG_REGEX_SUBSTITUTIONS'].
     """
 
     import unicodedata