New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide ability to create documentation for Arguments similar to Tasks #1708

Open
papauorg opened this Issue Jul 31, 2017 · 3 comments

Comments

Projects
None yet
3 participants
@papauorg

papauorg commented Jul 31, 2017

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

This comment has been minimized.

Member

mholo65 commented Jul 31, 2017

I think this kind of functionality will bring more value 👍

@StevenWolfe

This comment has been minimized.

StevenWolfe commented Aug 3, 2017

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

@papauorg

This comment has been minimized.

papauorg commented Aug 3, 2017

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment