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

Improve safe_version documentation
pypa · Aug 12, 2020 · f62a833 · f62a833
2 parents 6224065 + 44ca8aa
commit f62a833
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/changelog.d/2300.doc.rst b/changelog.d/2300.doc.rst
@@ -0,0 +1 @@
+Improve the ``safe_version`` function documentation
diff --git 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