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

[BUG] Command description not printin in help #259

Open
jlbosse opened this issue Oct 20, 2023 · 0 comments
Open

[BUG] Command description not printin in help #259

jlbosse opened this issue Oct 20, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@jlbosse
Copy link

jlbosse commented Oct 20, 2023

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.

@jlbosse jlbosse added the bug Something isn't working label Oct 20, 2023
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