Skip to content

Commit 58af37c

Browse files
committed
Replace the incorrect phrase about 'unescaping' and instead clarify that the transformations are irreversible.
1 parent f291ee0 commit 58af37c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/deprecated/python_eggs.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,10 @@ egg filename is as follows::
133133

134134
The "name" and "version" should be escaped using the ``to_filename()``
135135
function provided by ``pkg_resources``, after first processing them with
136-
``safe_name()`` and ``safe_version()`` respectively. These latter two
137-
functions can also be used to later "unescape" these parts of the
138-
filename. (For a detailed description of these transformations, please
139-
see the "Parsing Utilities" section of the ``pkg_resources`` manual.)
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.
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)