[documentation] add help how to write a custom help

[Raffaello]

it is not straight forward how to show a custom help, unless write a help function and avoid completely to use cxxopts.

and this will lead to do drop cxxopts.

please add a paragraph with an example how to do a custom help.

[jarro2783]

Do you mean that you want the help completely customised, or that you want to customise parts of the help?

You can already add a help string for each option, or you can write the help completely yourself, but it sounds like that is not what you want.

Can you give a better example of what you want to customise and I can see if it can be done?

[Raffaello]

apologies, the project has been dumped. At the moment i have difficulties to recall what was it for.

I think it was to write the help completely myself as it wasn't straight clear from the documentation and there is no example. (as far as i recall)

So just have a simple example for a cutstom help too. would be beneficial

[lazysegtree]

just have a simple example for a custom help too

@Raffaello What kind of custom help are you referring to? I assume it's not "write a help function and avoid completely to use cxxopts." Then what exactly do you have in mind? Can you provide a clear example, or explain what part of the help you want customized?

[Raffaello]

@lazysegtree
i don't remember. i think it was for some advanced sub options to explain in more details in the help screen.
As in the readme custom help: https://github.com/jarro2783/cxxopts?tab=readme-ov-file#custom-help
there is nothing really. as well the positional_help totally missing.

i don't remember what i was doing or what i was looking for in details but i had some needs of complex arguments with parameters and one parameter with one value will have a different following parameters. So kind of a tree of parameters instead of a list.

the custom help should have explained and give examples of that, but i don't remember what i had issue with that for as it was simpler to keep the project with a custom argument parsing instead of using a library at the very end.

[Raffaello]

my initial post on this issue is that if writing a custom help without any help from the cxxopts, at that points it is just simpler avoiding using cxxopts and just implement the cli parsing by myself as it is in a use case that cxxopts it is not helping to be a simpler tool for that, but instead it can be more complicated to customize "an advanced cli" especially due to lack of "advanced documentation"
(i think i meant something like this while i was head down on that project :) )

[lazysegtree]

My takeaways

• Documentation, especially around help printing, needs to be improved. Along with some examples
• Some library improvements may be needed to be able to write allow necessary customizations if needed. Someone needs to evaluate that.

The project lacks usage examples in general, which should be included to help new users easily fit thier use case to the library

[Raffaello]

(thanks for understanding)