docs: add example of plugin re-use

sopel-irc / sopel

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.

https://sopel.chat

Other

950 stars 405 forks source link

docs: add example of plugin re-use #2489

Closed SnoopJ closed 1 year ago

SnoopJ commented 1 year ago

Description

This changeset adds an example to the "tips and tricks" for plugins of importing another plugin and re-using a command from therein, as well as a warning about the potential for the duplication problem described in #2488.

Checklist

[x] I have read CONTRIBUTING.md
[x] I can and do license this contribution under the EFLv2
[N/A] No issues are reported by make qa (runs make quality and make test)
[x] I have tested the functionality of the things this change touches

SnoopJ commented 1 year ago

we should say that the single-file plugin type may not work this way, because it may not be importable

I'd love to see information of this sort added to Sopel, but I think it's a deeper subject than the warning I wanted to add in this case. I figure that users who are importing not-a-builtin-plugin are probably going to find out about the distinction anyway, and I'm not really sure how to expand this section to tackler the larger subject of how one might go about locating and importing plugins.

Do you think it makes sense to file a separate issue for fleshing out the subject?

Exirel commented 1 year ago

It's an advanced tips & tricks section, we can direct the reader to more resources without having to explain everything. Beside, there is an explanation about single-file plugin already. I don't think it's that deeper that it requires another issue: a single line in this section is enough in my opinion.