commandlineparser/commandline

Extended help information

Aperta

#337 aperta il 26 set 2018

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)C# (461 fork)batch import
enhancementgood first issue

Metriche repository

Star
 (4280 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Implementare un sistema di testo guida esteso, possibilmente aggiungendo nuove proprietà o un provider di guida separato per visualizzare informazioni aggiuntive per l'applicazione e i verbi quando si usa help. Considerare l'aggiunta di un attributo come `ExtendedHelpText` o la modifica del costruttore di guida.
Tech stack
csharp
Dominio
clitoolingdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
C#commandline library usage
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65