Skip to content

Commit

Permalink
Rearrange escaping functions to describe them in the order they shoul…
Browse files Browse the repository at this point in the history
…d be used.
  • Loading branch information
jaraco committed Feb 11, 2024
1 parent 58af37c commit 4aa55b8
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/deprecated/python_eggs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,12 @@ egg filename is as follows::

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

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. 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 "name" and "version" should be escaped using ``pkg_resources`` functions
``safe_name()`` and ``safe_version()`` respectively then using
``to_filename()``. 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 4aa55b8

Please sign in to comment.