Update stale docs references to pkg_resources as active module#5180
Open
Update stale docs references to pkg_resources as active module#5180
Conversation
Remove or update documentation that still refers to ``pkg_resources`` as an actively maintained module, following the deprecation completed in pypa#5173. Changes include: - docs/setuptools.rst: Rewrite Transitional Note to reflect that pkg_resources-style namespace packages are deprecated - docs/development/index.rst: Remove mention of pkg_resources module and reference manual - docs/userguide/distribution.rst: Replace pkg_resources.parse_version() with packaging.version.parse() - docs/userguide/extension.rst: Reference importlib.metadata as the primary API for EGG-INFO access - docs/userguide/package_discovery.rst: Fix ``pkg_resource`` typo (missing 's'), fix ``pkgutils`` typo, add deprecation admonition to Legacy Namespace Packages section - setuptools/dist.py: Replace pkg_resources.require() format reference with PEP 508 in install_requires docstring Closes pypa#5179 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Author
|
Hi maintainers, friendly ping on this PR. It's been open for about 8 days without any review activity. Would appreciate any feedback or direction when you get a chance. Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses #5179. Following the deprecation of
pkg_resourcescompleted in #5173, several non-historical documentation pages and docstrings still referencepkg_resourcesas though it is an actively maintained module. This PR updates those remaining references:pkg_resources-style namespace packages are deprecated, with a note directing users to PEP 420 implicit namespacespkg_resourcesmodule familiarity and reference manual (the reference manual no longer exists in the main docs)pkg_resources.parse_version()withpackaging.version.parse()and update examples to use PEP 440-compliant version stringsimportlib.metadataas the primary API for EGG-INFO metadata access, withpkg_resourcesas the predecessorpkg_resourcetypo (missings) in two places, fixpkgutilstypo (should bepkgutil), and add a.. deprecated::admonition to the Legacy Namespace Packages section clarifying these are no longer supportedpkg_resources.require()format reference with PEP 508 in theinstall_requiresdocstringTest plan
pkg_resourcesreferences in non-historical docs now either point to the modern replacement or are clearly marked as deprecated