From 4aa55b84ba2d919ef7d7d409a533da4cf947e11f Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 11 Feb 2024 14:29:40 -0500 Subject: [PATCH] Rearrange escaping functions to describe them in the order they should be used. --- docs/deprecated/python_eggs.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/deprecated/python_eggs.rst b/docs/deprecated/python_eggs.rst index 8519d27e3e..97548f183a 100644 --- a/docs/deprecated/python_eggs.rst +++ b/docs/deprecated/python_eggs.rst @@ -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