diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2020-08-12 16:25:50 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-12 16:25:50 -0400 |
| commit | f62a833c2bef9ecfd99e2da1516afb57ecc60491 (patch) | |
| tree | a31ea73492c5940b6f872cd0ebda2ee6aa71da56 /docs | |
| parent | 62240650e2adf58ae5a70bff75412db0de3985a1 (diff) | |
| parent | 44ca8aa51c39bea0c68444389d6ec215bcf98d02 (diff) | |
| download | python-setuptools-git-f62a833c2bef9ecfd99e2da1516afb57ecc60491.tar.gz | |
Merge pull request #2300 from athos-ribeiro/safe_verion-docs
Improve safe_version documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/pkg_resources.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/pkg_resources.txt b/docs/pkg_resources.txt index f2e554f4..7d0d8da9 100644 --- a/docs/pkg_resources.txt +++ b/docs/pkg_resources.txt @@ -1596,12 +1596,12 @@ Parsing Utilities See ``to_filename()``. ``safe_version(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()`` - except that spaces in the input become dots, and dots are allowed to exist - in the output. As with ``safe_name()``, if you are generating a filename - from this you should replace any "-" characters in the output with - underscores. + This will return the normalized form of any PEP 440 version. If the version + string is not PEP 440 compatible, this function behaves similar to + ``safe_name()`` except that spaces in the input become dots, and dots are + allowed to exist in the output. As with ``safe_name()``, if you are + generating a filename from this you should replace any "-" characters in + the output with underscores. ``safe_extra(extra)`` Return a "safe" form of an extra's name, suitable for use in a requirement |