Akuli / porcupine

A decent editor written in tkinter
MIT License
162 stars 49 forks source link

Warning if plugin has no docstring (description) #1484

Closed Akuli closed 8 months ago

Akuli commented 8 months ago

if a Porcupine plugin doesn't have a docstring, you get no warnings, and the plugin manager silently says:

https://github.com/Akuli/porcupine/blob/6ccbb1ecb7a508bc5a80be3935d9379371f66ced/porcupine/pluginmanager.py#L43

It would be better if a warning was logged when the plugin is loaded, so that a Porcupine developer realizes how important it is to add a docstring and what it does. The docstrings becomes the description of the plugin in the plugin manager.