comonicon / Comonicon.jl

Your best CLI generator in JuliaLang
https://comonicon.org
MIT License
282 stars 25 forks source link

[BUG] Command description not printin in help #259

Open jlbosse opened 10 months ago

jlbosse commented 10 months ago

Describe the bug The main description is not printed with the --help option

Version of the package: Comonicon.jl v1.0.6 julia v1.9.3

To Reproduce Create a file test with contents (taken from the documentation)

#!/usr/bin/env julia

"""
my command line interface.

# Arguments

- `arg`: an argument

# Options

- `-o, --option`: an option that has short option.

# Flags

- `-f, --flag`: a flag that has short flag.
"""
@main function mycmd(arg; option="Sam", flag::Bool=false)
    @show arg
    @show option
    @show flag
end

and run ./test -h in the same folder to find that it correctly prints the arguments and options, but not the main description "my command line interface"

Expected behavior Show the description "my command line interface" as shown in the documentation after the name of the function.