Skip to content

Commit 8baf9fd

Browse files
committed
Improve docstring for normalize method
1 parent ffe52f4 commit 8baf9fd

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

readthedocs/builds/version_slug.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,12 @@ def get_queryset(self, model_cls, slug_field):
8383

8484
def _normalize(self, content):
8585
"""
86-
Normalize some invalid characters to become a dash (``-``).
86+
Normalize some invalid characters (/, %, !, ?) to become a dash (``-``).
87+
88+
.. note::
89+
90+
We replace these characters to a dash to keep compatibility with the
91+
old behavior and also because it makes this more readable.
8792
8893
For example, ``release/1.0`` will become ``release-1.0``.
8994
"""

0 commit comments

Comments
 (0)