Skip to content

Commit

Permalink
Improve docstring for normalize method
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos committed Feb 18, 2019
1 parent ffe52f4 commit 8baf9fd
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion readthedocs/builds/version_slug.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,12 @@ def get_queryset(self, model_cls, slug_field):

def _normalize(self, content):
"""
Normalize some invalid characters to become a dash (``-``).
Normalize some invalid characters (/, %, !, ?) to become a dash (``-``).
.. note::
We replace these characters to a dash to keep compatibility with the
old behavior and also because it makes this more readable.
For example, ``release/1.0`` will become ``release-1.0``.
"""
Expand Down

0 comments on commit 8baf9fd

Please sign in to comment.