From 7a3a83245e0efce1df59783f33557a35a3203a5f Mon Sep 17 00:00:00 2001 From: James Gerity Date: Fri, 14 Jul 2023 20:26:29 -0400 Subject: [PATCH] docs: add warning about omitted details Co-authored-by: Florian Strzelecki --- docs/source/plugin/advanced.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/plugin/advanced.rst b/docs/source/plugin/advanced.rst index fec71209f..9f87ec46a 100644 --- a/docs/source/plugin/advanced.rst +++ b/docs/source/plugin/advanced.rst @@ -143,6 +143,11 @@ an alias for an existing command:: rules. For the most predictable results, import the other plugin as a module rather than unpacking its callables using a ``from`` import. +.. warning:: + + While this example shows off loading a built-in plugin, some plugins may + not be as easy to import. For example, a :term:`Single file plugin` may + not be available on ``sys.path`` without extra handling not shown here. Managing Capability negotiation ===============================