Comonicon.jl icon indicating copy to clipboard operation
Comonicon.jl copied to clipboard

print other parts of the doc string in detailed help info

Open Roger-luo opened this issue 5 years ago • 2 comments

currently only the required sections are displayed and parsed in the help info. We should definitely print the other parts as well, e.g if the doc string contains some sections other than Arguments, Options or Flags (like an Example section, or !!!note section etc.)

Roger-luo avatar Jul 23 '20 06:07 Roger-luo

It would also be nice if you can take screen width into consideration:

image

Or perhaps there's an alternative format for printing the docs where it doesn't depend on screen width?

kdheepak avatar Aug 19 '23 04:08 kdheepak

You can turn runtime printing on, the reason why width is not taken into account is mainly for making 1.8 and lower versions happy with the latency. Now with pkgimage this is getting much better we should probably consider a refactor of some of the CLI runtime to make it richer

Roger-luo avatar Aug 20 '23 04:08 Roger-luo