[BUG] Command description not printin in help

[jlbosse]

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.

[hsaribekyan]

I was also confused at this, but it turns out that you need to have # Introduction at the top of the docstring for it to appear. Link to documentation.

This is not very intuitive and in my view has issues such as not supporting more than a single paragraph. There is a related discussion on improving docstring handling.