cake-build/cake

Provide ability to create documentation for Arguments similar to Tasks

Open

#1 708 ouverte le 31 juil. 2017

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)C# (738 forks)batch import
FeatureHelp wantedUp-for-grabs

Métriques du dépôt

Stars
 (3 742 stars)
Métriques de merge PR
 (Merge moyen 1j 1h) (25 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez comment Task.Description est implémenté et reproduisez un modèle similaire pour Arguments. Regardez les méthodes Argument existantes et étendez les avec un paramètre de description.
Stack technique
csharp
Domaine
build system
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75