Skip to content

Commit 4aa55b8

Browse files
committed
Rearrange escaping functions to describe them in the order they should be used.
1 parent 58af37c commit 4aa55b8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/deprecated/python_eggs.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,12 +131,12 @@ egg filename is as follows::
131131

132132
name ["-" version ["-py" pyver ["-" required_platform]]] "." ext
133133

134-
The "name" and "version" should be escaped using the ``to_filename()``
135-
function provided by ``pkg_resources``, after first processing them with
136-
``safe_name()`` and ``safe_version()`` respectively. Note that the escaping is
137-
irreversible and the original name can only be retrieved from the distribution
138-
metadata. For a detailed description of these transformations, please see the
139-
"Parsing Utilities" section of the ``pkg_resources`` manual.
134+
The "name" and "version" should be escaped using ``pkg_resources`` functions
135+
``safe_name()`` and ``safe_version()`` respectively then using
136+
``to_filename()``. Note that the escaping is irreversible and the original
137+
name can only be retrieved from the distribution metadata. For a detailed
138+
description of these transformations, please see the "Parsing Utilities"
139+
section of the ``pkg_resources`` manual.
140140

141141
The "pyver" string is the Python major version, as found in the first
142142
3 characters of ``sys.version``. "required_platform" is essentially

0 commit comments

Comments
 (0)