bash-it icon indicating copy to clipboard operation
bash-it copied to clipboard

[Feature]: help information for preview command

Open jakebman opened this issue 3 years ago • 2 comments

Expected behavior

I'm asking for this feature because I'm not 100% sure what this help message should actually be. Is it this?

→ bash-it help preview
Previews a theme (you will still need to modify your bash-it settings to choose this theme)

Current behavior

There currently is no help text for preview

→ bash-it help preview
oops! preview is not a valid option!
bash-it             Bash-it help and maintenance
parameters:
                    1: verb [one of: help | show | enable | disable | migrate | update | search | preview | version | reload | restart | doctor ]
                    2: component type [one of: alias(es) | completion(s) | plugin(s) ] or search term(s)
                    3: specific component [optional]
examples:

Possible solution

function _help-preview() {
        _about 'help message for preview command'
        _group 'lib'

        # I'm not certain what this message should be
        echo "Previews a theme (you will still need to modify your bash-it settings to choose this theme)"
}

Context

This is a curiosity-level problem. If you really stretch, it's a usability problem that there's no help message here.

Notes

No response

jakebman avatar Jul 01 '22 14:07 jakebman

@jakebman, Can I Take This Issue ?

bleakprestiger avatar Nov 30 '22 13:11 bleakprestiger

@bleakprestiger, please, with my thanks. Be advised that the example help message is almost certainly wrong.

jakebman avatar Nov 30 '22 14:11 jakebman