commandlineparser/commandline

Extended help information

Ouverte

#337 ouverte le 26 sept. 2018

Voir sur GitHub
 (4 commentaires) (0 réaction) (0 personne assignée)C# (461 forks)batch import
enhancementgood first issue

Métriques du dépôt

Stars
 (4 280 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

I think that it would be nice if we could display additional text about application if someone types MyApp --help, and additional help for verb if someone types MyApp Verb --help.

I know there is HelpText property on BaseAttribute. It is nice for communicating what given option does, however I think that it is not suitable for extended, in-depth explanation. I would see it like that:

MyApp.exe help
MyApp 1.0.0
Copyright (C) 2018 MyApp 

  verb1    Help text for verb 1
  verb2    Help text for verb 2
  help             Display more information on a specific command.
  version          Display version information.

Long explanation about app

MyApp.exe help verb1
MyApp 1.0.0
Copyright (C) 2018 MyApp 

  verb1    Help text for verb 1
  verb2    Help text for verb 2
  help             Display more information on a specific command.
  version          Display version information.

Long explanation about verb1

Guide contributeur

Direction de recherche
Implémentez un système de texte d'aide étendu, éventuellement en ajoutant de nouvelles propriétés ou un fournisseur d'aide séparé pour afficher des informations supplémentaires pour l'application et les verbes lorsque help est utilisé. Envisagez d'ajouter un attribut comme `ExtendedHelpText` ou de modifier le constructeur d'aide.
Stack technique
csharp
Domaine
clitoolingdeveloper experience
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-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
C#commandline library usage
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65