Provide ability to create documentation for Arguments similar to Tasks #1708
Labels
Milestone
Comments
I think this kind of functionality will bring more value |
I like it, have you started dev on it or just suggesting the idea? |
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
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:
For registering a help text with an argument an additional parameter could be introduced to the already existing Argument methods. E.g.
Or some other way:
What do you think?
Best regards,
Philipp
The text was updated successfully, but these errors were encountered: