Skip to content

Commit f62a833

Browse files
authored
Merge pull request #2300 from athos-ribeiro/safe_verion-docs
Improve safe_version documentation
2 parents 6224065 + 44ca8aa commit f62a833

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

changelog.d/2300.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Improve the ``safe_version`` function documentation

docs/pkg_resources.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1596,12 +1596,12 @@ Parsing Utilities
15961596
See ``to_filename()``.
15971597

15981598
``safe_version(version)``
1599-
This will return the normalized form of any PEP 440 version, if the version
1600-
string is not PEP 440 compatible than it is similar to ``safe_name()``
1601-
except that spaces in the input become dots, and dots are allowed to exist
1602-
in the output. As with ``safe_name()``, if you are generating a filename
1603-
from this you should replace any "-" characters in the output with
1604-
underscores.
1599+
This will return the normalized form of any PEP 440 version. If the version
1600+
string is not PEP 440 compatible, this function behaves similar to
1601+
``safe_name()`` except that spaces in the input become dots, and dots are
1602+
allowed to exist in the output. As with ``safe_name()``, if you are
1603+
generating a filename from this you should replace any "-" characters in
1604+
the output with underscores.
16051605

16061606
``safe_extra(extra)``
16071607
Return a "safe" form of an extra's name, suitable for use in a requirement

0 commit comments

Comments
 (0)