FAQ, Q7: The example code makes no sense
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- csharp
- Área
- cli, documentation
Línea de trabajo
Comienza con la entrada Q7 de la wiki de CommandLine y revisa el comportamiento de HeadingInfo y del motor de ayuda predeterminado que se describe allí. Actualiza el ejemplo para que demuestre la personalización de la salida de ayuda predeterminada, incluido el manejo de --version, y asegúrate de que el ejemplo resultante explique la información de versión mostrada.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- C#
- Estrellas
- 4.8k
- Forks
- 478
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de commandlineparser/commandline
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
commandlineparser/commandline#951 · 1 comentario ·
-
Code example misses iEnumerable Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 70/100
commandlineparser/commandline#880 · 2 reacciones ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 45/100
commandlineparser/commandline#952 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
commandlineparser/commandline#948 ·
-
How to add examples for verbs? Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
commandlineparser/commandline#947 ·
Todos los issues de commandlineparser/commandline
Issues similares
-
core dependencies
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
-
bug frontend good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
NavigationViewItemAutomationPeer implements IInvokeProvider but never advertises the Invoke pattern Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
unoplatform/uno#24629 ·
-
agentic-workflows Needs: Triage :mag: State: In-PR
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Down / Waiting for removal
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100