Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FAQ, Q7: The example code makes no sense #939

Open
schittli opened this issue Nov 30, 2024 · 0 comments
Open

FAQ, Q7: The example code makes no sense #939

schittli opened this issue Nov 30, 2024 · 0 comments

Comments

@schittli
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant