eve icon indicating copy to clipboard operation
eve copied to clipboard

Provide Better Help

Open mdavis1982 opened this issue 9 years ago • 1 comments

Aim

The aim of this would be to provide better help to users of Eve. Currently, the help page is hard-coded into the help command and is therefore likely to become stale.

Ideally, we should add in a method of automatically curating the list of commands and what they do automatically.

Syntax

I propose that, in a Handler class, we introduce some variables as follows (using the slap command as an example):

private $name = 'slap';

private $signature = 'slap @user1 [@user2, @user3...]';

private $description = 'Some info about the command goes here. It can also be multiline using HEREDOC syntax';

private $visibility = Visibility::PUBLIC;

The help command can then get the registered Handler classes, and provide an always up-to-date list of commands.

In addition to this, it should hide admin-only commands unless and admin requests the help.

Nice To Have

It would be nice if the help command also accepted an argument for the command to help with and provided more detailed help and usage information.

mdavis1982 avatar Oct 18 '16 14:10 mdavis1982

I'd love to pick this up if no-one else has by the time I complete the currency conversion and Google commands.

andreaselia avatar Oct 19 '16 08:10 andreaselia