Document adding help text to command-line arguments

[allComputableThings]

Thanks for this project -- its really very handy.
Is there's support for printing help text?

[mivade]

Yes, if you add help in a field's metadata it will document a command-line argument. I'll leave this ticket open since it looks like this isn't explicitly documented.

[allComputableThings]

Thanks!. Is it possible to override the default --help handling? It tried detecting whether --help was provided by providing a `help:bool = False` field. This produces the error ```argparse.ArgumentError: argument --help: conflicting option string: --help``` I'd like to override it in order to: - report and group options by the dataclass in which they declared (I have many dataclasses classes in a hierarchy for a variety of components. - report the default values of each dataclass field (and maybe pull help text more conveniently from comment strings).

…

On Thu, Jun 16, 2022 at 8:31 AM Mike DePalatis ***@***.***> wrote: Yes, if you add help in a field's metadata it will document a command-line argument. I'll leave this ticket open since it looks like this isn't explicitly documented. — Reply to this email directly, view it on GitHub <#31 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB3QJLCWXTLVDVLNY7DEONLVPNCE3ANCNFSM5Y44A4PQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[mivade]

That is currently not possible but feel free to open a new ticket for a feature request. I don't spend too much time on this project these days but welcome contributions.