Skip to content

Commit

Permalink
docs: add warning about omitted details
Browse files Browse the repository at this point in the history
Co-authored-by: Florian Strzelecki <[email protected]>
  • Loading branch information
SnoopJ and Exirel committed Jul 15, 2023
1 parent c311cb3 commit 7a3a832
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/plugin/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===============================
Expand Down

0 comments on commit 7a3a832

Please sign in to comment.