Fix description of entry points mechanism#888
Merged
Conversation
- Show how a module would be loaded. A dictionary of modules will not be loaded, unless created by the user - Update links to external documentation - Hint that specifying entry points is not limited setuptools. For example flit (https://flit.readthedocs.io/en/latest/pyproject_toml.html#entry-points-sections) and poetry (https://python-poetry.org/docs/pyproject/#plugins) support it too.
webknjaz
reviewed
May 6, 2021
webknjaz
reviewed
May 6, 2021
webknjaz
reviewed
May 6, 2021
webknjaz
reviewed
May 6, 2021
webknjaz
approved these changes
May 6, 2021
Contributor
Author
|
Oh no.... you merged it too soon @webknjaz 😅 ! I wanted to add this change: From d16106c05e1e10f2821da5bdead7dbd5c691aba6 Mon Sep 17 00:00:00 2001
From: Ashwin Vishnu <y4d71nsar@relay.firefox.com>
Date: Thu, 6 May 2021 18:56:29 +0200
Subject: [PATCH] Clarify EntryPoints vs EntryPoint
---
source/guides/creating-and-discovering-plugins.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/source/guides/creating-and-discovering-plugins.rst b/source/guides/creating-and-discovering-plugins.rst
index 8fe1e41..ebdf876 100644
--- a/source/guides/creating-and-discovering-plugins.rst
+++ b/source/guides/creating-and-discovering-plugins.rst
@@ -151,7 +151,9 @@ Then you can discover and load all of the registered entry points by using
discovered_plugins = entry_points(group='myapp.plugins')
-In this example, ``discovered_plugins`` would be a collection of type :class:`importlib.metadata.EntryPoints`:
+In this example, ``discovered_plugins`` would be an
+:class:`importlib.metadata.EntryPoints` object, which is a sequence of all
+``EntryPoint`` objects belonging to the selected group.
.. code-block:: python
--
2.31.1
|
Member
|
@ashwinvis oh, you can send that in a follow-up PR. Also, if you want to mark a PR as not ready for review, just make it a Draft PR (normally you should be able to switch between draft and normal PR state at any point), or at least mark it as a WIP in the title — this will be a signal for the maintainers to postpone reviewing/merging it. |
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.
Following up on #870 and #879