WIP: implement HELP#129
Draft
internet-catte wants to merge 8 commits into
Draft
Conversation
internet-catte
commented
May 24, 2024
internet-catte
force-pushed
the
catte/help
branch
from
6cdd411 to
7590101
Compare
internet-catte
force-pushed
the
catte/help
branch
from
7590101 to
877a453
Compare
gfnord
added a commit
to gfnord/sable
that referenced
this pull request
Apr 18, 2026
Introduces a compile-time registry for free-form help topics that are
not tied to a command handler — channel modes, user modes, or any other
concept a user might query with HELP <topic>.
Topics are registered at the call site via inventory::submit!:
inventory::submit!(HelpTopic {
topic: "CMODE_SECRET",
lines: &[
"CMODE_SECRET (+s)",
"",
"Marks the channel as secret.",
],
});
CommandDispatcher gains two new methods:
- get_help_topic(topic) -> Option<&'static [&'static str]>
- iter_help_topics() -> impl Iterator<Item = &'static HelpTopic>
ClientServer forwards both so command handlers can call them directly.
A HELP handler (see Libera-Chat#129) should query the command registry for
command docs and fall back to get_help_topic() for concept entries,
giving full coverage with no runtime I/O.
gfnord
added a commit
to gfnord/sable
that referenced
this pull request
Apr 18, 2026
Introduces a compile-time registry for free-form help topics that are
not tied to a command handler — channel modes, user modes, or any other
concept a user might query with HELP <topic>.
Topics are registered at the call site via inventory::submit!:
inventory::submit!(HelpTopic {
topic: "CMODE_SECRET",
lines: &[
"CMODE_SECRET (+s)",
"",
"Marks the channel as secret.",
],
});
CommandDispatcher gains two new methods:
- get_help_topic(topic) -> Option<&'static [&'static str]>
- iter_help_topics() -> impl Iterator<Item = &'static HelpTopic>
ClientServer forwards both so command handlers can call them directly.
A HELP handler (see Libera-Chat#129) should query the command registry for
command docs and fall back to get_help_topic() for concept entries,
giving full coverage with no runtime I/O.
internet-catte
force-pushed
the
catte/help
branch
from
877a453 to
115f4ca
Compare
now supports aliases and restricted commands, captures docs
internet-catte
force-pushed
the
catte/help
branch
from
618afb9 to
f693101
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 does not work, or even compile yet, but I wanted some advice/guidance.
my plan here is:
HELP cmdRight now i've achieved 1 and 2, and have the mechanism of 4 mapped out, so the big question is how to link things up.
A similar method could be used for services help, but because of the limitations of
HELP(topics can only be one word), this would have to be done in the typical services way (NS HELP subcmd,CS HELP subcmd). This might be doable in this PR once the details are ironed out.Listing help topics is pretty straightforward, just get all the help topics and print them out. I've done it chunked to have something similar to solanum's output.