Repository navigation
Conversation
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.
The introductory examples show a single-module host and entry-point plugins, but do not show how a host can discover plugin files in a directory. Add a runnable greetings example between the complete example and the real-world references, with separate host, hookspecs and plugin modules.
The host uses
pkgutil.iter_modules()andimportlib.import_module(), sorts module names before registration, and skips subpackages. The documentation explains that discovery belongs to the host, how registration order relates to ordinary hook call order, and when entry-point loading is appropriate. Adding another plugin file requires no host changes. Pluggy's implementation and public APIs are unchanged.Refs #258. This addresses the directory-discovery example requested in the issue; broader documentation restructuring is outside this change.
Validation on Windows / CPython 3.12.13:
-Wand the Towncrier draft enabled (Sphinx 7.4.7); no warnings are suppressed for this change.OpenAI Codex assisted with implementation and local validation. No independent human review is claimed.