Skip to content

Commit

Permalink
Replace the incorrect phrase about 'unescaping' and instead clarify t…
Browse files Browse the repository at this point in the history
…hat the transformations are irreversible.
  • Loading branch information
jaraco committed Feb 11, 2024
1 parent f291ee0 commit 58af37c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/deprecated/python_eggs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,10 @@ egg filename is as follows::

The "name" and "version" should be escaped using the ``to_filename()``
function provided by ``pkg_resources``, after first processing them with
``safe_name()`` and ``safe_version()`` respectively. These latter two
functions can also be used to later "unescape" these parts of the
filename. (For a detailed description of these transformations, please
see the "Parsing Utilities" section of the ``pkg_resources`` manual.)
``safe_name()`` and ``safe_version()`` respectively. Note that the escaping is
irreversible and the original name can only be retrieved from the distribution
metadata. For a detailed description of these transformations, please see the
"Parsing Utilities" section of the ``pkg_resources`` manual.

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

0 comments on commit 58af37c

Please sign in to comment.