sopel-irc / sopel

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.
https://sopel.chat
Other
949 stars 403 forks source link

Expose more alias-friendly command docs #2487

Open dgw opened 1 year ago

dgw commented 1 year ago

Requested Feature

Way back in #577 (and #578), the bot's dictionary of command documentation was amended to include the docs for command aliases, too. But as far as I can tell, we still don't have a decent way to show the other aliases of a command on .help cmd.

sopel-help might be an external plugin now, but it still needs data from core APIs to work—and I can't see a way to accomplish this without modifications/additions to the available interface.

Problems Solved

When users do .help some-cmd, they should be able to see all related command names/aliases. The help plugin can't do this atm.

Alternatives

None I can think of. It's possible to use internal APIs in sopel.plugins.rules.Manager to see if a command or alias exists, but that doesn't help find the other names for that same command or alias.

An AbstractNamedRule has the property aliases, but again, one must know the "true" command name in order to find such a rule in the first place to check its aliases.

Notes

Might be easier to do this after we address #2318? It's sort of related, kinda.