Provide ability to create documentation for Arguments similar to Tasks

[papauorg]

Hi,

as described in this SO question: https://stackoverflow.com/questions/45413524/how-can-cake-build-arguments-be-documented
it would be great to be able to add documentation for Arguments as it is currently possible for Tasks by using the Description("...") method.

So e.g. executing the build script with the -showdescription parameter could show the described targets as well as the available arguments with an optional help text:

Task                          Description
=============================================================
Default                       Default Task Description

Argument                       Description
=============================================================
--someArgument=<int>           Argumentdescription. 
                               Can be multiline, maybe. Defaults to x.

--someOtherargument=<string>   Some other argument description

For registering a help text with an argument an additional parameter could be introduced to the already existing Argument methods. E.g.

Argument("someArgument", "x", "Argument description. Can be multiline, maybe.")

Or some other way:

var argValue = ArgumentBuilder("someArgument", "x")
                              .WithHelpText("Argument description. Can be multiline, maybe.")
                              .GetValue()

What do you think?

Best regards,
Philipp

[mholo65]

I think this kind of functionality will bring more value 👍

[StevenWolfe]

I like it, have you started dev on it or just suggesting the idea?

[papauorg]

No I didn't start. I could give it a try but I would need some hints on how to proceed. Also I can't promise to start right away.

Are you asking because you want to do it?