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

[Feature]: help information for preview command #2150

Open
jakebman opened this issue Jul 1, 2022 · 2 comments
Open

[Feature]: help information for preview command #2150

jakebman opened this issue Jul 1, 2022 · 2 comments

Comments

@jakebman
Copy link
Contributor

jakebman commented Jul 1, 2022

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

@bleakprestiger
Copy link

@jakebman, Can I Take This Issue ?

@jakebman
Copy link
Contributor Author

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

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

2 participants