Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Support HELP source customization #2975

Open
owllex opened this issue Nov 7, 2022 · 0 comments
Open

[Feature Request] Support HELP source customization #2975

owllex opened this issue Nov 7, 2022 · 0 comments
Labels
feature-request A suggestion for new functionality.

Comments

@owllex
Copy link
Contributor

owllex commented Nov 7, 2022

Is your feature request related to a problem? Please describe.

It would be helpful to break down the code in the HELP command's func to enable easier extension and customization. It's fairly long as it is and if you want to change it, it right now requires lots of copy and paste.

One use case would be adding extra sources of help in addition to the existing command-help, file-help, and DB help entries. For example, articles that are sourced from other objects' docstrings (as I do for skills, spells, and other abilities that don't have independent commands).

Describe the solution you'd like

For the use-case above, we could factor func to call another function that returns all of the searchable article candidates, grouped by category, and then have another function that knows how to retrieve that kind of article. There might be other ways to factor parts of func as well to enable other customization.

Alternatives you've considered

My use case could be solved by doing something creative with filehelp, but it's not ideal for many reasons. The only other option is to copy and paste the help func and modify it in place, but I'd rather we have a better solution than that, given how long help's func currently is.

@owllex owllex added the feature-request A suggestion for new functionality. label Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A suggestion for new functionality.
Projects
None yet
Development

No branches or pull requests

1 participant