Provide better formatting for long descriptions about powerargs

[adamabdelhamed]

How would you want them to be handled?

[dhilgarth]

As if Description was a column, i.e. in the screenshot, the text on the new line should start under the S of "Specifies" and not at the beginning of the new line.

[workabyte]

i agree with this one, would definitely improve readability

[adamabdelhamed]

This is now published in 2.4.0. Let me know what you think.

[dhilgarth]

Thanks! The following are the results of my tests:

Using ArgUsage.GetStyledUsage<DevToolArgs>().Write();: It still looks as before.
Using ArgUsage.GenerateUsageFromTemplate<DevToolArgs>().Write();: It does indent the wrapped text, but only after a blank line:

Using a template I created on my own is currently not possible, because the documentation is missing - the obsolete message for GetStyledUsage contains only a place holder.
Additionally, I don't know which template names are valid.

[adamabdelhamed]

Please try the patch I released yesterday. I think it will fix the newline issue. ArgUsage.GetStyledUsage is obsolete and will not be getting these enhancements.

There is basic documentation for the templating solution here. I'll update the TODOs in the code with this link in the next release. Thanks for finding this omission.

There are 2 built in templates that are located in the PowerArgs resources class. By default, the first one is used.

PowerArgs.Resources.DefaultConsoleUsageTemplate;
PowerArgs.Resources.DefaultBrowserUsageTemplate;

You need to supply the full template string, not the name of a template. So if you build your own you should probably put it in a resource file so it's easy to pass into ArgUsage.GenerateUsageFromTemplate();

[dhilgarth]

Thanks for the explanation with the templates.

Version 2.5 still shows the same behavior with the new line.

[Geraint87]

I'm using version 2.5.10.1 and it doesn't seem to be indenting the lines either:

ArgUsage.GenerateUsageFromTemplate<ApplicationArgs>().WriteLine();