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

Each command could be self-documenting #45

Open
Benjol opened this issue Feb 24, 2011 · 4 comments
Open

Each command could be self-documenting #45

Benjol opened this issue Feb 24, 2011 · 4 comments

Comments

@Benjol
Copy link

Benjol commented Feb 24, 2011

I created the /help command, but it's not really help, it just shows a list of commands.

I'm not sure how feasible it is, but it would be nice from the user's point of view to be able to do /help *command* and get some useful feedback about what the command does, and how to use it. Ideally each command would 'provide' it's own help text.

EDIT Actually, looking through the code, it seems to me that ChatExtensions could be pretty easily extended for this... Thoughts?

@tms
Copy link
Collaborator

tms commented Feb 25, 2011

Yeah, the way we display that information now is kind of ugly too. There's definitely room for improvement, so this is something I'd be happy to discuss.

@tms
Copy link
Collaborator

tms commented Jul 25, 2011

I added the code to support this now (not yet pushed), but the actual help texts will still need to be added.

@tms tms closed this as completed Jul 25, 2011
@tms tms reopened this Jul 25, 2011
@mvy
Copy link

mvy commented Jul 26, 2011

You can eventually push the feature. Maybe someone would have time to do the messages descriptions? Or at least could create a pull request for it. (If you don't have the time to do it of course :P)

@tms
Copy link
Collaborator

tms commented Jul 26, 2011

Yep, I just got distracted. I'll probably be pushing a few things later tonight.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants