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

Command description bug with options #112

Open
jacobdeichert opened this issue Jul 8, 2024 · 0 comments
Open

Command description bug with options #112

jacobdeichert opened this issue Jul 8, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@jacobdeichert
Copy link
Owner

jacobdeichert commented Jul 8, 2024

When writing "OPTIONS" right after the description (without an empty line in between), it causes the description to be listed as "OPTIONS".

## bad_desc
> this should be the description
**OPTIONS**
* whatever
    * flags: -w --whatever
    * desc: Whatever

~~~bash
echo "the description is wrong..."
~~~

Run mask help and see the output contains the wrong description for bad_desc:

mask 0.11.4

USAGE:
    mask [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help          Prints help information
        --introspect    Print out the maskfile command structure in json
    -V, --version       Prints version information

OPTIONS:
        --maskfile <maskfile>    Path to a different maskfile you want to use

SUBCOMMANDS:
    bad_desc    OPTIONS
@jacobdeichert jacobdeichert added the bug Something isn't working label Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant