cake-build/cake

Provide ability to create documentation for Arguments similar to Tasks

Open

#1708 aperta il 31 lug 2017

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)C# (738 fork)batch import
FeatureHelp wantedUp-for-grabs

Metriche repository

Star
 (3742 star)
Metriche merge PR
 (Merge medio 1g 1h) (25 PR mergiate in 30 g)

Descrizione

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.

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

Guida contributor

Direzione di ricerca
Esamina come viene implementato Task.Description e replica un pattern simile per Arguments. Guarda i metodi Argument esistenti e estendili con un parametro di descrizione.
Tech stack
csharp
Dominio
build system
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75