Add doc warning for risky plugin names (related to #1694) #1722
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
nzlosh
approved these changes
Apr 24, 2025
|
If you intended to push code changes to this PR, you should adjust the title as it no longer only addresses documentation. |
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.
This PR resolves Issue #1694 by adding a warning for plugin folders named lib, test, or utils. These names may cause plugin loading conflicts due to Python module resolution or backend-specific files (e.g., Slack's lib.py).
I reproduced the issue by creating a plugin in a lib/ folder, which failed to load silently. I added a log.warning(...) message in plugin_manager.py to alert developers early. I also added a documentation warning in docs/plugindevelopment.rst to guide plugin authors.
Let me know if you'd like anything adjusted.