FAQ, Q7: The example code makes no sense
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- csharp
- Domaine
- cli, documentation
Piste de recherche
Commencez par l’entrée Q7 du wiki de CommandLine et examinez le comportement de HeadingInfo et du moteur d’aide par défaut qui y sont décrits. Mettez à jour l’exemple afin qu’il montre la personnalisation de la sortie d’aide par défaut, y compris la gestion de --version, et veillez à ce que l’exemple résultant explique les informations de version affichées.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Hello,
thanks a lot for sharing your great and useful work!
I probably have just a small issue to Q7
https://github.com/commandlineparser/commandline/wiki/How-To#q7
with this question:
How to Display version information on Application startup?
The example code looks like this:
var title=new HeadingInfo(programName:"My supper Application",version:"1.2.3; App-Server:3.6.7");
Console.WriteLine( title );
// The Result will be:
My supper Application 1.2.3; App-Server:3.6.7
This example code makes no sense, because the code does nothing more than we could achieve with this code:
Console.WriteLine( "My supper Application 1.2.3; App-Server:3.6.7" );
The example should display how we can modify the default help engine, including the default --version parameter handling
so that the default help automatically uses this new HeadingInfo 😀
Describe the bug
It is a bug in the sense that the example code in the FAQ unfortunately does not show a relevant use-case on how to use HeadingInfo.
Expected behavior
It would be great if the example code shows how we can slightly modify the default behavior of the help engine.
Thanks a lot, kind regards,
Thomas
- Langage dominant
- C#
- Étoiles
- 4.8k
- Forks
- 478
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de commandlineparser/commandline
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
commandlineparser/commandline#951 · 1 commentaire ·
-
Code example misses iEnumerable Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 70/100
commandlineparser/commandline#880 · 2 réactions ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 45/100
commandlineparser/commandline#952 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
commandlineparser/commandline#948 ·
-
How to add examples for verbs? Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
commandlineparser/commandline#947 ·
Toutes les issues de commandlineparser/commandline
Issues similaires
-
core dependencies
Difficulté 1/5 Moins d'une heure Accessibilité débutants 80/100
-
bug frontend good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
NavigationViewItemAutomationPeer implements IInvokeProvider but never advertises the Invoke pattern Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
unoplatform/uno#24629 ·
-
agentic-workflows Needs: Triage :mag: State: In-PR
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
-
Down / Waiting for removal
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100