SourceForge has been redesigned. Learn more.

#371 add to describe aliases


It would be useful to be able to define the help text
for specific aliases.

alias add test echo test
alias help test "gives you a short test message"

!help test
... test <an alias,="" 0="" arguments=""> gives you a short test

Since we're using some more complicated aliases, this
would be nice :)


  • Jeremy Fincher

    Jeremy Fincher - 2004-10-11

    Logged In: YES

    Just a note for possible implementors: this is harder than it seems.

    Basically, we'll have to refactor getting a command's help to be a method
    on the plugin (instance of subclass of callbacks.Privmsg) object, and use
    that. It's an abstraction we've needed for awhile, but I've not gotten
    around to it.

  • Kevin Murphy

    Kevin Murphy - 2004-10-28

    Logged In: YES

    Now that the aforementioned refactoring of getting a
    command's help appears to have been done, this looks like it
    should be doable. I'll take a whack at it.

  • Jeremy Fincher

    Jeremy Fincher - 2004-11-19

    Logged In: YES

    Any progress on this?

  • Kevin Murphy

    Kevin Murphy - 2004-11-25

    Logged In: YES

    Principal coding on this is done, interface is generally as
    described above, except that the user-defined help text will
    override the doc value of the alias, so that an alias
    can be made to appear like a regular command if a user
    wishes. If no user-defined help is provided, the doc
    value will be used like the current functionality.

    Need to test this some more, and augment the test cases
    accordingly. Should commit within the next day or so.


Log in to post a comment.