Commit f62a833c authored by Jason R. Coombs's avatar Jason R. Coombs Committed by GitHub

Merge pull request #2300 from athos-ribeiro/safe_verion-docs

Improve safe_version documentation
parents 62240650 44ca8aa5
Improve the ``safe_version`` function documentation
...@@ -1596,12 +1596,12 @@ Parsing Utilities ...@@ -1596,12 +1596,12 @@ Parsing Utilities
See ``to_filename()``. See ``to_filename()``.
``safe_version(version)`` ``safe_version(version)``
This will return the normalized form of any PEP 440 version, if the version This will return the normalized form of any PEP 440 version. If the version
string is not PEP 440 compatible than it is similar to ``safe_name()`` string is not PEP 440 compatible, this function behaves similar to
except that spaces in the input become dots, and dots are allowed to exist ``safe_name()`` except that spaces in the input become dots, and dots are
in the output. As with ``safe_name()``, if you are generating a filename allowed to exist in the output. As with ``safe_name()``, if you are
from this you should replace any "-" characters in the output with generating a filename from this you should replace any "-" characters in
underscores. the output with underscores.
``safe_extra(extra)`` ``safe_extra(extra)``
Return a "safe" form of an extra's name, suitable for use in a requirement Return a "safe" form of an extra's name, suitable for use in a requirement
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment