Skip to content

Commit

Permalink
Document the incorrect behavior revealed by #4167.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Feb 11, 2024
1 parent 4aa55b8 commit f61e452
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/deprecated/python_eggs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,14 @@ Python version, or platform information is included. When the runtime
searches for available eggs, ``.egg-link`` files are opened and the
actual egg file/directory name is read from them.

Note: Due to `pypa/setuptools#4167
<https://github.com/pypa/setuptools/issues/4167>`_, the name in the egg-link
filename does not match the filename components used in similar files, but
instead presents with dash separators instead of underscore separators. For
compatibility with pip prior to version 24.0, these dash separators are
retained. In a future release, pip 24 or later will be required and the
underscore separators will be used.

Each ``.egg-link`` file should contain a single file or directory name,
with no newlines. This filename should be the base location of one or
more eggs. That is, the name must either end in ``.egg``, or else it
Expand Down

0 comments on commit f61e452

Please sign in to comment.